From c487b93ab4869377e4ace9033bcfdc264dbbd4cd Mon Sep 17 00:00:00 2001 From: Jonathan Remy Date: Wed, 29 Oct 2025 14:42:40 +0100 Subject: [PATCH] feat: add automatic README generation for npm packages --- packages/client/CHANGELOG.md | 4 + packages/client/package.json | 2 +- packages/configuration-loader/CHANGELOG.md | 4 + packages/configuration-loader/package.json | 2 +- packages/sdk/CHANGELOG.md | 14 +++ packages/sdk/package.json | 2 +- packages_generated/account/CHANGELOG.md | 7 ++ packages_generated/account/README.md | 96 +++++++++++++++++++ packages_generated/account/package.json | 3 +- packages_generated/applesilicon/CHANGELOG.md | 14 +++ packages_generated/applesilicon/README.md | 96 +++++++++++++++++++ packages_generated/applesilicon/package.json | 3 +- packages_generated/audit_trail/CHANGELOG.md | 26 +++++ packages_generated/audit_trail/README.md | 96 +++++++++++++++++++ packages_generated/audit_trail/package.json | 3 +- packages_generated/autoscaling/CHANGELOG.md | 7 ++ packages_generated/autoscaling/README.md | 96 +++++++++++++++++++ packages_generated/autoscaling/package.json | 3 +- packages_generated/baremetal/CHANGELOG.md | 13 +++ packages_generated/baremetal/README.md | 96 +++++++++++++++++++ packages_generated/baremetal/package.json | 3 +- packages_generated/billing/CHANGELOG.md | 7 ++ packages_generated/billing/README.md | 96 +++++++++++++++++++ packages_generated/billing/package.json | 3 +- packages_generated/block/CHANGELOG.md | 7 ++ packages_generated/block/README.md | 96 +++++++++++++++++++ packages_generated/block/package.json | 3 +- packages_generated/cockpit/CHANGELOG.md | 7 ++ packages_generated/cockpit/README.md | 96 +++++++++++++++++++ packages_generated/cockpit/package.json | 3 +- packages_generated/container/CHANGELOG.md | 11 +++ packages_generated/container/README.md | 96 +++++++++++++++++++ packages_generated/container/package.json | 3 +- packages_generated/datawarehouse/CHANGELOG.md | 8 ++ packages_generated/datawarehouse/README.md | 96 +++++++++++++++++++ packages_generated/datawarehouse/package.json | 3 +- packages_generated/dedibox/CHANGELOG.md | 11 +++ packages_generated/dedibox/README.md | 96 +++++++++++++++++++ packages_generated/dedibox/package.json | 3 +- packages_generated/domain/CHANGELOG.md | 12 +++ packages_generated/domain/README.md | 96 +++++++++++++++++++ packages_generated/domain/package.json | 3 +- packages_generated/edge_services/CHANGELOG.md | 9 ++ packages_generated/edge_services/README.md | 96 +++++++++++++++++++ packages_generated/edge_services/package.json | 3 +- .../environmental_footprint/CHANGELOG.md | 7 ++ .../environmental_footprint/README.md | 96 +++++++++++++++++++ .../environmental_footprint/package.json | 3 +- packages_generated/file/CHANGELOG.md | 6 ++ packages_generated/file/README.md | 96 +++++++++++++++++++ packages_generated/file/package.json | 3 +- packages_generated/flexibleip/CHANGELOG.md | 6 ++ packages_generated/flexibleip/README.md | 96 +++++++++++++++++++ packages_generated/flexibleip/package.json | 3 +- packages_generated/function/CHANGELOG.md | 11 +++ packages_generated/function/README.md | 96 +++++++++++++++++++ packages_generated/function/package.json | 3 +- packages_generated/iam/CHANGELOG.md | 21 ++++ packages_generated/iam/README.md | 96 +++++++++++++++++++ packages_generated/iam/package.json | 3 +- packages_generated/inference/CHANGELOG.md | 8 ++ packages_generated/inference/README.md | 96 +++++++++++++++++++ packages_generated/inference/package.json | 3 +- packages_generated/instance/CHANGELOG.md | 14 +++ packages_generated/instance/README.md | 96 +++++++++++++++++++ packages_generated/instance/package.json | 3 +- packages_generated/interlink/CHANGELOG.md | 8 ++ packages_generated/interlink/README.md | 96 +++++++++++++++++++ packages_generated/interlink/package.json | 3 +- packages_generated/iot/CHANGELOG.md | 7 ++ packages_generated/iot/README.md | 96 +++++++++++++++++++ packages_generated/iot/package.json | 3 +- packages_generated/ipam/CHANGELOG.md | 8 ++ packages_generated/ipam/README.md | 96 +++++++++++++++++++ packages_generated/ipam/package.json | 3 +- packages_generated/jobs/CHANGELOG.md | 6 ++ packages_generated/jobs/README.md | 96 +++++++++++++++++++ packages_generated/jobs/package.json | 3 +- packages_generated/k8s/CHANGELOG.md | 18 ++++ packages_generated/k8s/README.md | 96 +++++++++++++++++++ packages_generated/k8s/package.json | 3 +- packages_generated/key_manager/CHANGELOG.md | 11 +++ packages_generated/key_manager/README.md | 96 +++++++++++++++++++ packages_generated/key_manager/package.json | 3 +- packages_generated/lb/CHANGELOG.md | 11 +++ packages_generated/lb/README.md | 96 +++++++++++++++++++ packages_generated/lb/package.json | 3 +- packages_generated/marketplace/CHANGELOG.md | 7 ++ packages_generated/marketplace/README.md | 96 +++++++++++++++++++ packages_generated/marketplace/package.json | 3 +- packages_generated/mnq/CHANGELOG.md | 7 ++ packages_generated/mnq/README.md | 96 +++++++++++++++++++ packages_generated/mnq/package.json | 3 +- packages_generated/mongodb/CHANGELOG.md | 7 ++ packages_generated/mongodb/README.md | 96 +++++++++++++++++++ packages_generated/mongodb/package.json | 3 +- .../product_catalog/CHANGELOG.md | 14 +++ packages_generated/product_catalog/README.md | 96 +++++++++++++++++++ .../product_catalog/package.json | 3 +- packages_generated/qaas/CHANGELOG.md | 10 ++ packages_generated/qaas/README.md | 96 +++++++++++++++++++ packages_generated/qaas/package.json | 3 +- packages_generated/rdb/CHANGELOG.md | 7 ++ packages_generated/rdb/README.md | 96 +++++++++++++++++++ packages_generated/rdb/package.json | 3 +- packages_generated/redis/CHANGELOG.md | 6 ++ packages_generated/redis/README.md | 96 +++++++++++++++++++ packages_generated/redis/package.json | 3 +- packages_generated/registry/CHANGELOG.md | 6 ++ packages_generated/registry/README.md | 96 +++++++++++++++++++ packages_generated/registry/package.json | 3 +- packages_generated/s2s_vpn/CHANGELOG.md | 13 +++ packages_generated/s2s_vpn/README.md | 96 +++++++++++++++++++ packages_generated/s2s_vpn/package.json | 3 +- packages_generated/secret/CHANGELOG.md | 7 ++ packages_generated/secret/README.md | 96 +++++++++++++++++++ packages_generated/secret/package.json | 3 +- .../serverless_sqldb/CHANGELOG.md | 6 ++ packages_generated/serverless_sqldb/README.md | 96 +++++++++++++++++++ .../serverless_sqldb/package.json | 3 +- packages_generated/std/CHANGELOG.md | 6 ++ packages_generated/std/package.json | 3 +- packages_generated/tem/CHANGELOG.md | 9 ++ packages_generated/tem/README.md | 96 +++++++++++++++++++ packages_generated/tem/package.json | 3 +- packages_generated/test/CHANGELOG.md | 6 ++ packages_generated/test/README.md | 96 +++++++++++++++++++ packages_generated/test/package.json | 3 +- packages_generated/vpc/CHANGELOG.md | 6 ++ packages_generated/vpc/README.md | 96 +++++++++++++++++++ packages_generated/vpc/package.json | 3 +- packages_generated/vpcgw/CHANGELOG.md | 6 ++ packages_generated/vpcgw/README.md | 96 +++++++++++++++++++ packages_generated/vpcgw/package.json | 3 +- packages_generated/webhosting/CHANGELOG.md | 19 ++++ packages_generated/webhosting/README.md | 96 +++++++++++++++++++ packages_generated/webhosting/package.json | 3 +- scripts/generatePackages.ts | 20 ++++ scripts/helpers.ts | 20 ++++ scripts/templates/README.tmpl | 95 ++++++++++++++++++ scripts/templates/package.tmpl | 3 +- 141 files changed, 4801 insertions(+), 48 deletions(-) create mode 100644 packages_generated/account/README.md create mode 100644 packages_generated/applesilicon/README.md create mode 100644 packages_generated/audit_trail/README.md create mode 100644 packages_generated/autoscaling/README.md create mode 100644 packages_generated/baremetal/README.md create mode 100644 packages_generated/billing/README.md create mode 100644 packages_generated/block/README.md create mode 100644 packages_generated/cockpit/README.md create mode 100644 packages_generated/container/README.md create mode 100644 packages_generated/datawarehouse/README.md create mode 100644 packages_generated/dedibox/README.md create mode 100644 packages_generated/domain/README.md create mode 100644 packages_generated/edge_services/README.md create mode 100644 packages_generated/environmental_footprint/README.md create mode 100644 packages_generated/file/README.md create mode 100644 packages_generated/flexibleip/README.md create mode 100644 packages_generated/function/README.md create mode 100644 packages_generated/iam/README.md create mode 100644 packages_generated/inference/README.md create mode 100644 packages_generated/instance/README.md create mode 100644 packages_generated/interlink/README.md create mode 100644 packages_generated/iot/README.md create mode 100644 packages_generated/ipam/README.md create mode 100644 packages_generated/jobs/README.md create mode 100644 packages_generated/k8s/README.md create mode 100644 packages_generated/key_manager/README.md create mode 100644 packages_generated/lb/README.md create mode 100644 packages_generated/marketplace/README.md create mode 100644 packages_generated/mnq/README.md create mode 100644 packages_generated/mongodb/README.md create mode 100644 packages_generated/product_catalog/README.md create mode 100644 packages_generated/qaas/README.md create mode 100644 packages_generated/rdb/README.md create mode 100644 packages_generated/redis/README.md create mode 100644 packages_generated/registry/README.md create mode 100644 packages_generated/s2s_vpn/README.md create mode 100644 packages_generated/secret/README.md create mode 100644 packages_generated/serverless_sqldb/README.md create mode 100644 packages_generated/tem/README.md create mode 100644 packages_generated/test/README.md create mode 100644 packages_generated/vpc/README.md create mode 100644 packages_generated/vpcgw/README.md create mode 100644 packages_generated/webhosting/README.md create mode 100644 scripts/templates/README.tmpl diff --git a/packages/client/CHANGELOG.md b/packages/client/CHANGELOG.md index 6fca9b9fd..3b7d2f4bf 100644 --- a/packages/client/CHANGELOG.md +++ b/packages/client/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## 1.3.3 (2025-10-29) + +**Note:** Version bump only for package @scaleway/sdk-client + ## 1.3.2 (2025-10-22) **Note:** Version bump only for package @scaleway/sdk-client diff --git a/packages/client/package.json b/packages/client/package.json index 9d9a008b8..99b89d89a 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -1,6 +1,6 @@ { "name": "@scaleway/sdk-client", - "version": "1.3.2", + "version": "1.3.3", "license": "Apache-2.0", "description": "Scaleway SDK Client", "keywords": [ diff --git a/packages/configuration-loader/CHANGELOG.md b/packages/configuration-loader/CHANGELOG.md index 44b0624a8..0fb37b023 100644 --- a/packages/configuration-loader/CHANGELOG.md +++ b/packages/configuration-loader/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +## 1.0.12 (2025-10-29) + +**Note:** Version bump only for package @scaleway/configuration-loader + ## 1.0.11 (2025-10-22) **Note:** Version bump only for package @scaleway/configuration-loader diff --git a/packages/configuration-loader/package.json b/packages/configuration-loader/package.json index 0689a23ef..e491d5dbf 100644 --- a/packages/configuration-loader/package.json +++ b/packages/configuration-loader/package.json @@ -1,6 +1,6 @@ { "name": "@scaleway/configuration-loader", - "version": "1.0.11", + "version": "1.0.12", "license": "Apache-2.0", "description": "Load configuration via file or environment for NodeJS.", "publishConfig": { diff --git a/packages/sdk/CHANGELOG.md b/packages/sdk/CHANGELOG.md index 4f0090a80..9417e66f3 100644 --- a/packages/sdk/CHANGELOG.md +++ b/packages/sdk/CHANGELOG.md @@ -3,6 +3,20 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [2.78.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk@2.76.7...@scaleway/sdk@2.78.0) (2025-10-29) + +### Bug Fixes + +- read real exports from packages instead of guessing names to fix TypeScript compilation errors ([#2460](https://github.com/scaleway/scaleway-sdk-js/issues/2460)) ([c8c424e](https://github.com/scaleway/scaleway-sdk-js/commit/c8c424e09d3a365a2592f25abdc0a8d6d86e0f0b)) +- **s2s_vpn:** add packages ([#2400](https://github.com/scaleway/scaleway-sdk-js/issues/2400)) ([5703403](https://github.com/scaleway/scaleway-sdk-js/commit/5703403f87dccf9e7f6d8e52c278608c440a6dca)) +- **scripts:** move writeFileSync outside loop in generateAlias to fix EUNCOMMIT error in CI ([#2526](https://github.com/scaleway/scaleway-sdk-js/issues/2526)) ([bc6434c](https://github.com/scaleway/scaleway-sdk-js/commit/bc6434c08d27f836b8836407852deeaa3ac19807)) + +### Features + +- **datawarehouse:** update the visibility to public ([#2406](https://github.com/scaleway/scaleway-sdk-js/issues/2406)) ([a38b83e](https://github.com/scaleway/scaleway-sdk-js/commit/a38b83e50f63f7741285fe9ba065bb9af5f7f016)) +- **environmental_footprint:** enable v1alpha1 ([#2441](https://github.com/scaleway/scaleway-sdk-js/issues/2441)) ([dec421b](https://github.com/scaleway/scaleway-sdk-js/commit/dec421b7f42d91ec51b63c117764e5c3a606ddf7)) +- sdk export createclient ([#2425](https://github.com/scaleway/scaleway-sdk-js/issues/2425)) ([d8ecf1c](https://github.com/scaleway/scaleway-sdk-js/commit/d8ecf1c4c4e2a497e89d23265752d9d6e3aa73d2)) + # [2.77.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk@2.76.7...@scaleway/sdk@2.77.0) (2025-10-22) ### Bug Fixes diff --git a/packages/sdk/package.json b/packages/sdk/package.json index 7de036f4b..084d7ca2a 100644 --- a/packages/sdk/package.json +++ b/packages/sdk/package.json @@ -1,6 +1,6 @@ { "name": "@scaleway/sdk", - "version": "2.77.0", + "version": "2.78.0", "description": "Scaleway SDK TS.", "license": "Apache-2.0", "files": [ diff --git a/packages_generated/account/CHANGELOG.md b/packages_generated/account/CHANGELOG.md index f41f03bf8..7bbd5453b 100644 --- a/packages_generated/account/CHANGELOG.md +++ b/packages_generated/account/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- **account:** add network contract type ([#2442](https://github.com/scaleway/scaleway-sdk-js/issues/2442)) ([74882bb](https://github.com/scaleway/scaleway-sdk-js/commit/74882bb953a0f08a68c348ee43c90d2e9c24c03e)) +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/account/README.md b/packages_generated/account/README.md new file mode 100644 index 000000000..64e3f7eb0 --- /dev/null +++ b/packages_generated/account/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-account + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-account.svg)](https://www.npmjs.com/package/@scaleway/sdk-account) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-account.svg)](https://www.npmjs.com/package/@scaleway/sdk-account) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-account.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Account 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-account @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-account @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-account @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 { Account } from '@scaleway/sdk-account' + +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 Account.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 { Account } from '@scaleway/sdk-account' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Account.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Account API Documentation](https://www.scaleway.com/en/developers/api/account/) +- πŸ“– [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. + diff --git a/packages_generated/account/package.json b/packages_generated/account/package.json index eac8c7927..89375e281 100644 --- a/packages_generated/account/package.json +++ b/packages_generated/account/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-account", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK account", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/applesilicon/CHANGELOG.md b/packages_generated/applesilicon/CHANGELOG.md index 036953ba0..1508f7783 100644 --- a/packages_generated/applesilicon/CHANGELOG.md +++ b/packages_generated/applesilicon/CHANGELOG.md @@ -3,6 +3,20 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.5.0 (2025-10-29) + +### Bug Fixes + +- **apple_silicon:** add missing servertype infos for PCU ([#2434](https://github.com/scaleway/scaleway-sdk-js/issues/2434)) ([0c1af30](https://github.com/scaleway/scaleway-sdk-js/commit/0c1af3083bf8f31447caf26d7616eeb311208a05)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **apple_silicon:** add CI-CD runner installation APIs ([#2440](https://github.com/scaleway/scaleway-sdk-js/issues/2440)) ([bd2e810](https://github.com/scaleway/scaleway-sdk-js/commit/bd2e810df231e57fa8c077f2e01745e5103add29)) +- **apple_silicon:** enable bulk order in public sdk ([#2234](https://github.com/scaleway/scaleway-sdk-js/issues/2234)) ([babbfe9](https://github.com/scaleway/scaleway-sdk-js/commit/babbfe98789b22774f04a43f49a7ce9fb9a43628)) +- **apple_silicon:** fix typo in applesilicon SDK comment ([#2238](https://github.com/scaleway/scaleway-sdk-js/issues/2238)) ([be0bbe9](https://github.com/scaleway/scaleway-sdk-js/commit/be0bbe908921b948de70bac7abed592e5957e2ef)) +- **applesilicon:** remove support for `runner_configuration` ([#2457](https://github.com/scaleway/scaleway-sdk-js/issues/2457)) ([5119374](https://github.com/scaleway/scaleway-sdk-js/commit/5119374aa5657ee80d994af276adb83c333d11ab)) + # 1.4.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/applesilicon/README.md b/packages_generated/applesilicon/README.md new file mode 100644 index 000000000..27e8cfa7a --- /dev/null +++ b/packages_generated/applesilicon/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-applesilicon + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-applesilicon.svg)](https://www.npmjs.com/package/@scaleway/sdk-applesilicon) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-applesilicon.svg)](https://www.npmjs.com/package/@scaleway/sdk-applesilicon) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-applesilicon.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Applesilicon 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-applesilicon @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-applesilicon @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-applesilicon @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 { Applesilicon } from '@scaleway/sdk-applesilicon' + +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 Applesilicon.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 { Applesilicon } from '@scaleway/sdk-applesilicon' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Applesilicon.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Applesilicon API Documentation](https://www.scaleway.com/en/developers/api/applesilicon/) +- πŸ“– [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. + diff --git a/packages_generated/applesilicon/package.json b/packages_generated/applesilicon/package.json index 370c89e7b..6b949803a 100644 --- a/packages_generated/applesilicon/package.json +++ b/packages_generated/applesilicon/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-applesilicon", - "version": "1.4.0", + "version": "1.5.0", "description": "Scaleway SDK applesilicon", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/audit_trail/CHANGELOG.md b/packages_generated/audit_trail/CHANGELOG.md index 1f22a4e60..6209ba475 100644 --- a/packages_generated/audit_trail/CHANGELOG.md +++ b/packages_generated/audit_trail/CHANGELOG.md @@ -3,6 +3,32 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.6.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-audit-trail@1.3.0...@scaleway/sdk-audit-trail@1.6.0) (2025-10-29) + +### Bug Fixes + +- **audit_trail:** add export tags as repeated string ([#2516](https://github.com/scaleway/scaleway-sdk-js/issues/2516)) ([e848cb9](https://github.com/scaleway/scaleway-sdk-js/commit/e848cb934c4fc188b0bd2e49f95a8728f99b9523)) + +### Features + +- **audit_trail/v1alpha1:** add iam saml resources ([#2408](https://github.com/scaleway/scaleway-sdk-js/issues/2408)) ([7c5ad71](https://github.com/scaleway/scaleway-sdk-js/commit/7c5ad71f8ce9d9397be41a7e4d2817cca37e0000)) +- **audit_trail:** add a new sfs_filesystem resource ([#2369](https://github.com/scaleway/scaleway-sdk-js/issues/2369)) ([64fe049](https://github.com/scaleway/scaleway-sdk-js/commit/64fe04902f1d4b18da7584017e24098216e336bc)) +- **audit_trail:** add apple-silicon resources definition ([#2241](https://github.com/scaleway/scaleway-sdk-js/issues/2241)) ([38e3f5e](https://github.com/scaleway/scaleway-sdk-js/commit/38e3f5eb1aaf818a025ecea2e97acc090ae270e7)) +- **audit_trail:** add authentication events in public API ([#2374](https://github.com/scaleway/scaleway-sdk-js/issues/2374)) ([9ca66aa](https://github.com/scaleway/scaleway-sdk-js/commit/9ca66aa435e2bdfdd8e1dffd78a90e44d140a343)) +- **audit_trail:** add baremetal resources and account ([#2268](https://github.com/scaleway/scaleway-sdk-js/issues/2268)) ([a248ca6](https://github.com/scaleway/scaleway-sdk-js/commit/a248ca6304d5c17b482363f0fb78e17614f040b0)) +- **audit_trail:** add event export ([#2447](https://github.com/scaleway/scaleway-sdk-js/issues/2447)) ([cf778ac](https://github.com/scaleway/scaleway-sdk-js/commit/cf778ac91a6518317c9ab26b4aa3652bb7b5b862)) +- **audit_trail:** add export removal ([#2452](https://github.com/scaleway/scaleway-sdk-js/issues/2452)) ([b8a5566](https://github.com/scaleway/scaleway-sdk-js/commit/b8a556622add2292a729e5c952bd1bce236040dd)) +- **audit_trail:** add exports listing ([#2458](https://github.com/scaleway/scaleway-sdk-js/issues/2458)) ([5298246](https://github.com/scaleway/scaleway-sdk-js/commit/52982461f6535ec6fe313418b118bfe142339aed)) +- **audit_trail:** add instance resources ([#2342](https://github.com/scaleway/scaleway-sdk-js/issues/2342)) ([c578aaf](https://github.com/scaleway/scaleway-sdk-js/commit/c578aaf98753b79035e250e69ca75b888272744b)) +- **audit_trail:** add instances resources for disk management ([#2345](https://github.com/scaleway/scaleway-sdk-js/issues/2345)) ([b041972](https://github.com/scaleway/scaleway-sdk-js/commit/b041972a164d60ecc049dc4ca858911db908403b)) +- **audit_trail:** add last status to export job ([#2485](https://github.com/scaleway/scaleway-sdk-js/issues/2485)) ([477d534](https://github.com/scaleway/scaleway-sdk-js/commit/477d53433e213cfb9e9284950c66bb7f6ec7ed05)) +- **audit_trail:** add lb resources ([#2364](https://github.com/scaleway/scaleway-sdk-js/issues/2364)) ([7d6a35b](https://github.com/scaleway/scaleway-sdk-js/commit/7d6a35b04a6b6ee86bf6f4de5e2d667f12faa963)) +- **audit_trail:** add private network resource ([#2376](https://github.com/scaleway/scaleway-sdk-js/issues/2376)) ([fadb9f4](https://github.com/scaleway/scaleway-sdk-js/commit/fadb9f4030d7ecace6cd6c100e6990808a0862a7)) +- **audit_trail:** add support for `EventSystem` ([#2278](https://github.com/scaleway/scaleway-sdk-js/issues/2278)) ([82a4689](https://github.com/scaleway/scaleway-sdk-js/commit/82a4689d7648bd5e70c8533caa572bea503fe534)) +- **audit_trail:** add support for `principalId` and `sourceIp` ([#2377](https://github.com/scaleway/scaleway-sdk-js/issues/2377)) ([54576e5](https://github.com/scaleway/scaleway-sdk-js/commit/54576e591e0bdda764eadf92c03f0d41754299ff)) +- **audit_trail:** remove deprecated resource field ([#2235](https://github.com/scaleway/scaleway-sdk-js/issues/2235)) ([a1b410c](https://github.com/scaleway/scaleway-sdk-js/commit/a1b410c395622727b2cb6a42d17c97698d45db98)) +- **audit_trail:** support system events ([#2415](https://github.com/scaleway/scaleway-sdk-js/issues/2415)) ([69acd57](https://github.com/scaleway/scaleway-sdk-js/commit/69acd57ead0af6746b03722cb457f723f0e7ddf2)) + # [1.5.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-audit-trail@1.3.0...@scaleway/sdk-audit-trail@1.5.0) (2025-10-22) ### Bug Fixes diff --git a/packages_generated/audit_trail/README.md b/packages_generated/audit_trail/README.md new file mode 100644 index 000000000..70310d806 --- /dev/null +++ b/packages_generated/audit_trail/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-audit-trail + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-audit-trail.svg)](https://www.npmjs.com/package/@scaleway/sdk-audit-trail) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-audit-trail.svg)](https://www.npmjs.com/package/@scaleway/sdk-audit-trail) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-audit-trail.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Audit Trail 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-audit-trail @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-audit-trail @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-audit-trail @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 { AuditTrail } from '@scaleway/sdk-audit-trail' + +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 AuditTrail.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 { AuditTrail } from '@scaleway/sdk-audit-trail' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new AuditTrail.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Audit Trail API Documentation](https://www.scaleway.com/en/developers/api/audit-trail/) +- πŸ“– [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. + diff --git a/packages_generated/audit_trail/package.json b/packages_generated/audit_trail/package.json index d62a2c000..77a935919 100644 --- a/packages_generated/audit_trail/package.json +++ b/packages_generated/audit_trail/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-audit-trail", - "version": "1.5.0", + "version": "1.6.0", "description": "Scaleway SDK audit-trail", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/autoscaling/CHANGELOG.md b/packages_generated/autoscaling/CHANGELOG.md index 425aedabc..daa95ac7d 100644 --- a/packages_generated/autoscaling/CHANGELOG.md +++ b/packages_generated/autoscaling/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **autoscaling:** add zone in resources ([#2449](https://github.com/scaleway/scaleway-sdk-js/issues/2449)) ([1395247](https://github.com/scaleway/scaleway-sdk-js/commit/139524740f11bb1e7452ec8965174ddb4f1f0d2d)) + # 1.2.0 (2025-10-22) ### Features diff --git a/packages_generated/autoscaling/README.md b/packages_generated/autoscaling/README.md new file mode 100644 index 000000000..08bc3b78a --- /dev/null +++ b/packages_generated/autoscaling/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-autoscaling + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-autoscaling.svg)](https://www.npmjs.com/package/@scaleway/sdk-autoscaling) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-autoscaling.svg)](https://www.npmjs.com/package/@scaleway/sdk-autoscaling) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-autoscaling.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Autoscaling 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-autoscaling @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-autoscaling @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-autoscaling @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 { Autoscaling } from '@scaleway/sdk-autoscaling' + +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 Autoscaling.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 { Autoscaling } from '@scaleway/sdk-autoscaling' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Autoscaling.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Autoscaling API Documentation](https://www.scaleway.com/en/developers/api/autoscaling/) +- πŸ“– [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. + diff --git a/packages_generated/autoscaling/package.json b/packages_generated/autoscaling/package.json index 954f236dd..0d5b87cfc 100644 --- a/packages_generated/autoscaling/package.json +++ b/packages_generated/autoscaling/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-autoscaling", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK autoscaling", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/baremetal/CHANGELOG.md b/packages_generated/baremetal/CHANGELOG.md index 1f8f947d6..252f8757b 100644 --- a/packages_generated/baremetal/CHANGELOG.md +++ b/packages_generated/baremetal/CHANGELOG.md @@ -3,6 +3,19 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Bug Fixes + +- **baremetal:** rename content.gen to content.gen.js for explicit JS extension ([#2489](https://github.com/scaleway/scaleway-sdk-js/issues/2489)) ([518cecd](https://github.com/scaleway/scaleway-sdk-js/commit/518cecd8e8c8aaaa3f68208a14a4bb2b9acf6f1e)) + +### Features + +- **baremetal:** add protected flag on servers ([#2255](https://github.com/scaleway/scaleway-sdk-js/issues/2255)) ([217b6aa](https://github.com/scaleway/scaleway-sdk-js/commit/217b6aa1302c359c351a3d1e1f7eee44824781e0)) +- **baremetal:** expose user_data field for cloud-init ([#2531](https://github.com/scaleway/scaleway-sdk-js/issues/2531)) ([a38b190](https://github.com/scaleway/scaleway-sdk-js/commit/a38b190a2d4957b5babfc09954c19aa9d6cce28c)) +- **baremetal:** expose zone for offers and os ([#2496](https://github.com/scaleway/scaleway-sdk-js/issues/2496)) ([47f4e16](https://github.com/scaleway/scaleway-sdk-js/commit/47f4e16eea9f55281e62ec85455b6ffd92d9fd43)) +- **baremetal:** support overriding default SSH keys on rescue ([#2360](https://github.com/scaleway/scaleway-sdk-js/issues/2360)) ([d05d2f0](https://github.com/scaleway/scaleway-sdk-js/commit/d05d2f0f6c45c72f456f10ac25d8225d501becb7)) + # 1.2.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/baremetal/README.md b/packages_generated/baremetal/README.md new file mode 100644 index 000000000..812a47979 --- /dev/null +++ b/packages_generated/baremetal/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-baremetal + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-baremetal.svg)](https://www.npmjs.com/package/@scaleway/sdk-baremetal) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-baremetal.svg)](https://www.npmjs.com/package/@scaleway/sdk-baremetal) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-baremetal.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Baremetal 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-baremetal @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-baremetal @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-baremetal @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 { Baremetal } from '@scaleway/sdk-baremetal' + +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 Baremetal.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 { Baremetal } from '@scaleway/sdk-baremetal' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Baremetal.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Baremetal API Documentation](https://www.scaleway.com/en/developers/api/baremetal/) +- πŸ“– [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. + diff --git a/packages_generated/baremetal/package.json b/packages_generated/baremetal/package.json index c94148b95..9a2fdce30 100644 --- a/packages_generated/baremetal/package.json +++ b/packages_generated/baremetal/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-baremetal", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK baremetal", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/billing/CHANGELOG.md b/packages_generated/billing/CHANGELOG.md index 3aa690525..4088d53a6 100644 --- a/packages_generated/billing/CHANGELOG.md +++ b/packages_generated/billing/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **billing:** add consumer_id to v2beta1.ListConsumptions ([#2537](https://github.com/scaleway/scaleway-sdk-js/issues/2537)) ([4601ce2](https://github.com/scaleway/scaleway-sdk-js/commit/4601ce287f855cd8499db74a332dcb86869b2980)) + # 1.2.0 (2025-10-22) ### Features diff --git a/packages_generated/billing/README.md b/packages_generated/billing/README.md new file mode 100644 index 000000000..fd0a4da87 --- /dev/null +++ b/packages_generated/billing/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-billing + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-billing.svg)](https://www.npmjs.com/package/@scaleway/sdk-billing) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-billing.svg)](https://www.npmjs.com/package/@scaleway/sdk-billing) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-billing.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Billing 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-billing @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-billing @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-billing @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 { Billing } from '@scaleway/sdk-billing' + +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 Billing.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 { Billing } from '@scaleway/sdk-billing' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Billing.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Billing API Documentation](https://www.scaleway.com/en/developers/api/billing/) +- πŸ“– [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. + diff --git a/packages_generated/billing/package.json b/packages_generated/billing/package.json index f7d49dbde..3bc983bc4 100644 --- a/packages_generated/billing/package.json +++ b/packages_generated/billing/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-billing", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK billing", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/block/CHANGELOG.md b/packages_generated/block/CHANGELOG.md index 26b64be30..0f5051797 100644 --- a/packages_generated/block/CHANGELOG.md +++ b/packages_generated/block/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **block:** allow display of unpurged resources ([#2319](https://github.com/scaleway/scaleway-sdk-js/issues/2319)) ([868efe3](https://github.com/scaleway/scaleway-sdk-js/commit/868efe314a9a582f05fd74cd5d20636f1ca4ee00)) + # 1.2.0 (2025-10-22) ### Features diff --git a/packages_generated/block/README.md b/packages_generated/block/README.md new file mode 100644 index 000000000..141f90a0c --- /dev/null +++ b/packages_generated/block/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-block + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-block.svg)](https://www.npmjs.com/package/@scaleway/sdk-block) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-block.svg)](https://www.npmjs.com/package/@scaleway/sdk-block) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-block.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Block 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-block @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-block @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-block @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 { Block } from '@scaleway/sdk-block' + +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 Block.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 { Block } from '@scaleway/sdk-block' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Block.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Block API Documentation](https://www.scaleway.com/en/developers/api/block/) +- πŸ“– [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. + diff --git a/packages_generated/block/package.json b/packages_generated/block/package.json index d518891db..786969845 100644 --- a/packages_generated/block/package.json +++ b/packages_generated/block/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-block", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK block", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/cockpit/CHANGELOG.md b/packages_generated/cockpit/CHANGELOG.md index 38c0d0f18..908d116b3 100644 --- a/packages_generated/cockpit/CHANGELOG.md +++ b/packages_generated/cockpit/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.7.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-cockpit@1.4.0...@scaleway/sdk-cockpit@1.7.0) (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **cockpit:** add rule status on ListAlert endpoint ([#2236](https://github.com/scaleway/scaleway-sdk-js/issues/2236)) ([afbf0f3](https://github.com/scaleway/scaleway-sdk-js/commit/afbf0f3a11c97872af66e9948cf5f4bb1f49096a)) + # [1.6.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-cockpit@1.4.0...@scaleway/sdk-cockpit@1.6.0) (2025-10-22) ### Features diff --git a/packages_generated/cockpit/README.md b/packages_generated/cockpit/README.md new file mode 100644 index 000000000..8f08cc1da --- /dev/null +++ b/packages_generated/cockpit/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-cockpit + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-cockpit.svg)](https://www.npmjs.com/package/@scaleway/sdk-cockpit) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-cockpit.svg)](https://www.npmjs.com/package/@scaleway/sdk-cockpit) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-cockpit.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Cockpit 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-cockpit @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-cockpit @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-cockpit @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 { Cockpit } from '@scaleway/sdk-cockpit' + +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 Cockpit.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 { Cockpit } from '@scaleway/sdk-cockpit' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Cockpit.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Cockpit API Documentation](https://www.scaleway.com/en/developers/api/cockpit/) +- πŸ“– [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. + diff --git a/packages_generated/cockpit/package.json b/packages_generated/cockpit/package.json index a444bc413..b4952feb0 100644 --- a/packages_generated/cockpit/package.json +++ b/packages_generated/cockpit/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-cockpit", - "version": "1.6.0", + "version": "1.7.0", "description": "Scaleway SDK cockpit", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/container/CHANGELOG.md b/packages_generated/container/CHANGELOG.md index 8609e52c1..2707ba975 100644 --- a/packages_generated/container/CHANGELOG.md +++ b/packages_generated/container/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.8.0 (2025-10-29) + +### Bug Fixes + +- **serverless:** allow empty string for privateNetworkID in create ([#2223](https://github.com/scaleway/scaleway-sdk-js/issues/2223)) ([2513104](https://github.com/scaleway/scaleway-sdk-js/commit/2513104f91ac70978d75469c4205a3335839b97e)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **serverless:** deprecate activate_vpc_integration and update documentation ([#2318](https://github.com/scaleway/scaleway-sdk-js/issues/2318)) ([0a6e366](https://github.com/scaleway/scaleway-sdk-js/commit/0a6e3666b9dc6755a05f00912b1c80648c2f6923)) + # 1.7.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/container/README.md b/packages_generated/container/README.md new file mode 100644 index 000000000..22d5ef8cf --- /dev/null +++ b/packages_generated/container/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. + diff --git a/packages_generated/container/package.json b/packages_generated/container/package.json index e86450a86..9f6a170dc 100644 --- a/packages_generated/container/package.json +++ b/packages_generated/container/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-container", - "version": "1.7.0", + "version": "1.8.0", "description": "Scaleway SDK container", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/datawarehouse/CHANGELOG.md b/packages_generated/datawarehouse/CHANGELOG.md index 2f1abce87..dda81f4dd 100644 --- a/packages_generated/datawarehouse/CHANGELOG.md +++ b/packages_generated/datawarehouse/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **datawarehouse:** add data warehouse to doc website ([#2540](https://github.com/scaleway/scaleway-sdk-js/issues/2540)) ([bfef9bf](https://github.com/scaleway/scaleway-sdk-js/commit/bfef9bf05397f6ee7b8eb7e7f75faeb325ceebd1)) +- **datawarehouse:** update the visibility to public ([#2406](https://github.com/scaleway/scaleway-sdk-js/issues/2406)) ([a38b83e](https://github.com/scaleway/scaleway-sdk-js/commit/a38b83e50f63f7741285fe9ba065bb9af5f7f016)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/datawarehouse/README.md b/packages_generated/datawarehouse/README.md new file mode 100644 index 000000000..dfcba5f8d --- /dev/null +++ b/packages_generated/datawarehouse/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-datawarehouse + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-datawarehouse.svg)](https://www.npmjs.com/package/@scaleway/sdk-datawarehouse) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-datawarehouse.svg)](https://www.npmjs.com/package/@scaleway/sdk-datawarehouse) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-datawarehouse.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Datawarehouse 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-datawarehouse @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-datawarehouse @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-datawarehouse @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 { Datawarehouse } from '@scaleway/sdk-datawarehouse' + +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 Datawarehouse.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 { Datawarehouse } from '@scaleway/sdk-datawarehouse' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Datawarehouse.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Datawarehouse API Documentation](https://www.scaleway.com/en/developers/api/datawarehouse/) +- πŸ“– [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. + diff --git a/packages_generated/datawarehouse/package.json b/packages_generated/datawarehouse/package.json index 0d74e8ac0..ed361c64a 100644 --- a/packages_generated/datawarehouse/package.json +++ b/packages_generated/datawarehouse/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-datawarehouse", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK datawarehouse", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/dedibox/CHANGELOG.md b/packages_generated/dedibox/CHANGELOG.md index aeb8c9d1e..eefce8cd8 100644 --- a/packages_generated/dedibox/CHANGELOG.md +++ b/packages_generated/dedibox/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.4.0 (2025-10-29) + +### Bug Fixes + +- **dedibox:** remove project_id from LeaveRpnGroupRequest ([#2444](https://github.com/scaleway/scaleway-sdk-js/issues/2444)) ([c054cd7](https://github.com/scaleway/scaleway-sdk-js/commit/c054cd7ffbe4a461a654e9e1aadf2f0a21f366ad)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **dedibox:** provide ListIPv6Blocks endpoint ([#2470](https://github.com/scaleway/scaleway-sdk-js/issues/2470)) ([7216f58](https://github.com/scaleway/scaleway-sdk-js/commit/7216f58b3cfde0dbef4442199af79480c604fc2e)) + # 1.3.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/dedibox/README.md b/packages_generated/dedibox/README.md new file mode 100644 index 000000000..15bc68999 --- /dev/null +++ b/packages_generated/dedibox/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-dedibox + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-dedibox.svg)](https://www.npmjs.com/package/@scaleway/sdk-dedibox) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-dedibox.svg)](https://www.npmjs.com/package/@scaleway/sdk-dedibox) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-dedibox.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Dedibox 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-dedibox @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-dedibox @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-dedibox @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 { Dedibox } from '@scaleway/sdk-dedibox' + +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 Dedibox.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 { Dedibox } from '@scaleway/sdk-dedibox' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Dedibox.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Dedibox API Documentation](https://www.scaleway.com/en/developers/api/dedibox/) +- πŸ“– [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. + diff --git a/packages_generated/dedibox/package.json b/packages_generated/dedibox/package.json index 75bf383db..83b4a451c 100644 --- a/packages_generated/dedibox/package.json +++ b/packages_generated/dedibox/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-dedibox", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK dedibox", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/domain/CHANGELOG.md b/packages_generated/domain/CHANGELOG.md index f1465298c..f561766a2 100644 --- a/packages_generated/domain/CHANGELOG.md +++ b/packages_generated/domain/CHANGELOG.md @@ -3,6 +3,18 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Bug Fixes + +- **domain:** fix typo in doc ([#2455](https://github.com/scaleway/scaleway-sdk-js/issues/2455)) ([104db95](https://github.com/scaleway/scaleway-sdk-js/commit/104db95abe1c47e4fffca7d6d71e40746a1e9417)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **domain:** expose inbound transfer status ([#2351](https://github.com/scaleway/scaleway-sdk-js/issues/2351)) ([62e22fe](https://github.com/scaleway/scaleway-sdk-js/commit/62e22feffab6c4693ef786d9c77e09336483da92)) +- **domain:** support inbound transfer retry ([#2443](https://github.com/scaleway/scaleway-sdk-js/issues/2443)) ([fb3ef35](https://github.com/scaleway/scaleway-sdk-js/commit/fb3ef35c9bdc5811827ecdda886904a1ae81ed31)) + # 1.2.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/domain/README.md b/packages_generated/domain/README.md new file mode 100644 index 000000000..9419ac0a7 --- /dev/null +++ b/packages_generated/domain/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-domain + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-domain.svg)](https://www.npmjs.com/package/@scaleway/sdk-domain) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-domain.svg)](https://www.npmjs.com/package/@scaleway/sdk-domain) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-domain.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Domain 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-domain @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-domain @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-domain @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 { Domain } from '@scaleway/sdk-domain' + +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 Domain.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 { Domain } from '@scaleway/sdk-domain' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Domain.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Domain API Documentation](https://www.scaleway.com/en/developers/api/domain/) +- πŸ“– [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. + diff --git a/packages_generated/domain/package.json b/packages_generated/domain/package.json index 9204098ea..595e0d6ef 100644 --- a/packages_generated/domain/package.json +++ b/packages_generated/domain/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-domain", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK domain", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/edge_services/CHANGELOG.md b/packages_generated/edge_services/CHANGELOG.md index 02f08933d..400aaba73 100644 --- a/packages_generated/edge_services/CHANGELOG.md +++ b/packages_generated/edge_services/CHANGELOG.md @@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.4.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-edge-services@1.1.0...@scaleway/sdk-edge-services@1.4.0) (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **edge_services:** add default_fqdn to dns_stage ([#2504](https://github.com/scaleway/scaleway-sdk-js/issues/2504)) ([489ae1f](https://github.com/scaleway/scaleway-sdk-js/commit/489ae1fbd4943e3ba529809e64a32775420beade)) +- **edge_services:** add route rule search endpoint ([#2244](https://github.com/scaleway/scaleway-sdk-js/issues/2244)) ([062ee36](https://github.com/scaleway/scaleway-sdk-js/commit/062ee36a3ad675dd87f5c312b18d5b348a0b7157)) +- **edge_services:** add tls caa malfunction error ([#2464](https://github.com/scaleway/scaleway-sdk-js/issues/2464)) ([f760795](https://github.com/scaleway/scaleway-sdk-js/commit/f760795038b424f6af7c1a27c7b29c121c9dec93)) + # [1.3.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-edge-services@1.1.0...@scaleway/sdk-edge-services@1.3.0) (2025-10-22) ### Features diff --git a/packages_generated/edge_services/README.md b/packages_generated/edge_services/README.md new file mode 100644 index 000000000..b0b5ac7da --- /dev/null +++ b/packages_generated/edge_services/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-edge-services + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-edge-services.svg)](https://www.npmjs.com/package/@scaleway/sdk-edge-services) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-edge-services.svg)](https://www.npmjs.com/package/@scaleway/sdk-edge-services) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-edge-services.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Edge Services 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-edge-services @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-edge-services @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-edge-services @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 { EdgeServices } from '@scaleway/sdk-edge-services' + +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 EdgeServices.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 { EdgeServices } from '@scaleway/sdk-edge-services' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new EdgeServices.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Edge Services API Documentation](https://www.scaleway.com/en/developers/api/edge-services/) +- πŸ“– [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. + diff --git a/packages_generated/edge_services/package.json b/packages_generated/edge_services/package.json index 75092f93b..806507542 100644 --- a/packages_generated/edge_services/package.json +++ b/packages_generated/edge_services/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-edge-services", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK edge-services", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/environmental_footprint/CHANGELOG.md b/packages_generated/environmental_footprint/CHANGELOG.md index 4f6cccd2c..e4011019b 100644 --- a/packages_generated/environmental_footprint/CHANGELOG.md +++ b/packages_generated/environmental_footprint/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **environmental_footprint:** enable v1alpha1 ([#2441](https://github.com/scaleway/scaleway-sdk-js/issues/2441)) ([dec421b](https://github.com/scaleway/scaleway-sdk-js/commit/dec421b7f42d91ec51b63c117764e5c3a606ddf7)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/environmental_footprint/README.md b/packages_generated/environmental_footprint/README.md new file mode 100644 index 000000000..427cc9024 --- /dev/null +++ b/packages_generated/environmental_footprint/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-environmental-footprint + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-environmental-footprint.svg)](https://www.npmjs.com/package/@scaleway/sdk-environmental-footprint) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-environmental-footprint.svg)](https://www.npmjs.com/package/@scaleway/sdk-environmental-footprint) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-environmental-footprint.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Environmental Footprint 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-environmental-footprint @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-environmental-footprint @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-environmental-footprint @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 { EnvironmentalFootprint } from '@scaleway/sdk-environmental-footprint' + +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 EnvironmentalFootprint.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 { EnvironmentalFootprint } from '@scaleway/sdk-environmental-footprint' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new EnvironmentalFootprint.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Environmental Footprint API Documentation](https://www.scaleway.com/en/developers/api/environmental-footprint/) +- πŸ“– [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. + diff --git a/packages_generated/environmental_footprint/package.json b/packages_generated/environmental_footprint/package.json index 2fbef43cc..d5e566a3d 100644 --- a/packages_generated/environmental_footprint/package.json +++ b/packages_generated/environmental_footprint/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-environmental-footprint", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK environmental-footprint", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/file/CHANGELOG.md b/packages_generated/file/CHANGELOG.md index 5462146aa..d8a5331ac 100644 --- a/packages_generated/file/CHANGELOG.md +++ b/packages_generated/file/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.2.0 (2025-10-22) ### Features diff --git a/packages_generated/file/README.md b/packages_generated/file/README.md new file mode 100644 index 000000000..9a58eb3a3 --- /dev/null +++ b/packages_generated/file/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-file + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-file.svg)](https://www.npmjs.com/package/@scaleway/sdk-file) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-file.svg)](https://www.npmjs.com/package/@scaleway/sdk-file) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-file.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for File 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-file @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-file @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-file @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 { File } from '@scaleway/sdk-file' + +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 File.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 { File } from '@scaleway/sdk-file' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new File.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway File API Documentation](https://www.scaleway.com/en/developers/api/file/) +- πŸ“– [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. + diff --git a/packages_generated/file/package.json b/packages_generated/file/package.json index 16e3f4126..56662a939 100644 --- a/packages_generated/file/package.json +++ b/packages_generated/file/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-file", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK file", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/flexibleip/CHANGELOG.md b/packages_generated/flexibleip/CHANGELOG.md index 7f955368a..13a91a132 100644 --- a/packages_generated/flexibleip/CHANGELOG.md +++ b/packages_generated/flexibleip/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/flexibleip/README.md b/packages_generated/flexibleip/README.md new file mode 100644 index 000000000..36054fd23 --- /dev/null +++ b/packages_generated/flexibleip/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-flexibleip + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-flexibleip.svg)](https://www.npmjs.com/package/@scaleway/sdk-flexibleip) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-flexibleip.svg)](https://www.npmjs.com/package/@scaleway/sdk-flexibleip) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-flexibleip.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Flexibleip 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-flexibleip @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-flexibleip @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-flexibleip @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 { Flexibleip } from '@scaleway/sdk-flexibleip' + +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 Flexibleip.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 { Flexibleip } from '@scaleway/sdk-flexibleip' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Flexibleip.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Flexibleip API Documentation](https://www.scaleway.com/en/developers/api/flexibleip/) +- πŸ“– [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. + diff --git a/packages_generated/flexibleip/package.json b/packages_generated/flexibleip/package.json index b6a03c415..eea895c44 100644 --- a/packages_generated/flexibleip/package.json +++ b/packages_generated/flexibleip/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-flexibleip", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK flexibleip", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/function/CHANGELOG.md b/packages_generated/function/CHANGELOG.md index aea40132d..1c450c6a8 100644 --- a/packages_generated/function/CHANGELOG.md +++ b/packages_generated/function/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.7.0 (2025-10-29) + +### Bug Fixes + +- **serverless:** allow empty string for privateNetworkID in create ([#2223](https://github.com/scaleway/scaleway-sdk-js/issues/2223)) ([2513104](https://github.com/scaleway/scaleway-sdk-js/commit/2513104f91ac70978d75469c4205a3335839b97e)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **serverless:** deprecate activate_vpc_integration and update documentation ([#2318](https://github.com/scaleway/scaleway-sdk-js/issues/2318)) ([0a6e366](https://github.com/scaleway/scaleway-sdk-js/commit/0a6e3666b9dc6755a05f00912b1c80648c2f6923)) + # 1.6.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/function/README.md b/packages_generated/function/README.md new file mode 100644 index 000000000..c9008fefd --- /dev/null +++ b/packages_generated/function/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. + diff --git a/packages_generated/function/package.json b/packages_generated/function/package.json index 8642df2bf..35aac8a27 100644 --- a/packages_generated/function/package.json +++ b/packages_generated/function/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-function", - "version": "1.6.0", + "version": "1.7.0", "description": "Scaleway SDK function", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/iam/CHANGELOG.md b/packages_generated/iam/CHANGELOG.md index c73252c6d..4d4c1efd1 100644 --- a/packages_generated/iam/CHANGELOG.md +++ b/packages_generated/iam/CHANGELOG.md @@ -3,6 +3,27 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.6.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-iam@1.3.0...@scaleway/sdk-iam@1.6.0) (2025-10-29) + +### Bug Fixes + +- **iam/v1alpha1:** add max_bytes rule to password validation ([#2259](https://github.com/scaleway/scaleway-sdk-js/issues/2259)) ([c9a68c1](https://github.com/scaleway/scaleway-sdk-js/commit/c9a68c13fa69f50182e301da89efe95165a4477f)) +- **iam/v1alpha1:** add max_bytes rule to update password validation ([#2260](https://github.com/scaleway/scaleway-sdk-js/issues/2260)) ([ab7dde5](https://github.com/scaleway/scaleway-sdk-js/commit/ab7dde5289593fc942b2558185a311f35764d15e)) +- **iam/v1alpha1:** set UpdateOrganizationLoginMethods body ([#2508](https://github.com/scaleway/scaleway-sdk-js/issues/2508)) ([08c24a6](https://github.com/scaleway/scaleway-sdk-js/commit/08c24a64096de5c596f251919cc2f3780f38554c)) + +### Features + +- **iam/v1alpha1:** add GetSamlInformation ([#2324](https://github.com/scaleway/scaleway-sdk-js/issues/2324)) ([71db561](https://github.com/scaleway/scaleway-sdk-js/commit/71db5612a9d20b18c97932831c2cddf12ebcccc3)) +- **iam/v1alpha1:** add ParseSamlMetadata ([#2523](https://github.com/scaleway/scaleway-sdk-js/issues/2523)) ([b0db04d](https://github.com/scaleway/scaleway-sdk-js/commit/b0db04de8017560b9897b0a4bc3b598cebcc756e)) +- **iam/v1alpha1:** add UpdateOrganizationLoginMethods ([#2484](https://github.com/scaleway/scaleway-sdk-js/issues/2484)) ([9b35ebb](https://github.com/scaleway/scaleway-sdk-js/commit/9b35ebbefe6e9edc6ad6f32885db5373079f7fff)) +- **iam:** add expires_at to updateable API key fields ([#2532](https://github.com/scaleway/scaleway-sdk-js/issues/2532)) ([6b7d806](https://github.com/scaleway/scaleway-sdk-js/commit/6b7d806b150889d13a44186a37685dde83689d3a)) +- **iam:** add max_api_key_expiration_duration to OrganizationSecuritySettings ([#2527](https://github.com/scaleway/scaleway-sdk-js/issues/2527)) ([deb9c44](https://github.com/scaleway/scaleway-sdk-js/commit/deb9c4413f5db5570f6af51c88af5763f533f1af)) +- **iam:** add max_login_session_days security setting ([#2450](https://github.com/scaleway/scaleway-sdk-js/issues/2450)) ([72dff65](https://github.com/scaleway/scaleway-sdk-js/commit/72dff65c03d7fbd71f03d6e36cbe78f9e098a210)) +- **iam:** add saml certificate expires_at field ([#2248](https://github.com/scaleway/scaleway-sdk-js/issues/2248)) ([95288dc](https://github.com/scaleway/scaleway-sdk-js/commit/95288dc74cc591026533ace8189a198f531305e1)) +- **iam:** remove guest from user type ([#2494](https://github.com/scaleway/scaleway-sdk-js/issues/2494)) ([f21355c](https://github.com/scaleway/scaleway-sdk-js/commit/f21355c92a8ca675af3c894877d0754224b88e4d)) +- **iam:** remove MigrateOrganizationGuests method ([#2507](https://github.com/scaleway/scaleway-sdk-js/issues/2507)) ([ef40081](https://github.com/scaleway/scaleway-sdk-js/commit/ef4008131343cd6bab1f5e20dbba8616688b89ee)) +- **iam:** rework saml endpoints ([#2346](https://github.com/scaleway/scaleway-sdk-js/issues/2346)) ([6d3a37d](https://github.com/scaleway/scaleway-sdk-js/commit/6d3a37dfcf4731df4546827ea73d60f55147eb22)) + # [1.5.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-iam@1.3.0...@scaleway/sdk-iam@1.5.0) (2025-10-22) ### Bug Fixes diff --git a/packages_generated/iam/README.md b/packages_generated/iam/README.md new file mode 100644 index 000000000..0c4608c22 --- /dev/null +++ b/packages_generated/iam/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-iam + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-iam.svg)](https://www.npmjs.com/package/@scaleway/sdk-iam) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-iam.svg)](https://www.npmjs.com/package/@scaleway/sdk-iam) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-iam.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Iam 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-iam @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-iam @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-iam @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 { Iam } from '@scaleway/sdk-iam' + +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 Iam.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 { Iam } from '@scaleway/sdk-iam' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Iam.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Iam API Documentation](https://www.scaleway.com/en/developers/api/iam/) +- πŸ“– [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. + diff --git a/packages_generated/iam/package.json b/packages_generated/iam/package.json index ec8979714..4e1db3caf 100644 --- a/packages_generated/iam/package.json +++ b/packages_generated/iam/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-iam", - "version": "1.5.0", + "version": "1.6.0", "description": "Scaleway SDK iam", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/inference/CHANGELOG.md b/packages_generated/inference/CHANGELOG.md index 19a72c3d0..c8ddda2b2 100644 --- a/packages_generated/inference/CHANGELOG.md +++ b/packages_generated/inference/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **inference:** add model size to verify model response ([#2328](https://github.com/scaleway/scaleway-sdk-js/issues/2328)) ([d7d47a0](https://github.com/scaleway/scaleway-sdk-js/commit/d7d47a0a5b875352869a23aef25eb05db1531877)) +- **inference:** add scaling deployment status ([#2311](https://github.com/scaleway/scaleway-sdk-js/issues/2311)) ([8f23fcf](https://github.com/scaleway/scaleway-sdk-js/commit/8f23fcfd7d8d0ea6dcb4821a188c874f034b9372)) + # 1.2.0 (2025-10-22) ### Features diff --git a/packages_generated/inference/README.md b/packages_generated/inference/README.md new file mode 100644 index 000000000..5e9c135f0 --- /dev/null +++ b/packages_generated/inference/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-inference + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-inference.svg)](https://www.npmjs.com/package/@scaleway/sdk-inference) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-inference.svg)](https://www.npmjs.com/package/@scaleway/sdk-inference) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-inference.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Inference 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-inference @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-inference @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-inference @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 { Inference } from '@scaleway/sdk-inference' + +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 Inference.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 { Inference } from '@scaleway/sdk-inference' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Inference.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Inference API Documentation](https://www.scaleway.com/en/developers/api/inference/) +- πŸ“– [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. + diff --git a/packages_generated/inference/package.json b/packages_generated/inference/package.json index 60e70a260..9da517160 100644 --- a/packages_generated/inference/package.json +++ b/packages_generated/inference/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-inference", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK inference", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/instance/CHANGELOG.md b/packages_generated/instance/CHANGELOG.md index 35d935578..7fd39bd71 100644 --- a/packages_generated/instance/CHANGELOG.md +++ b/packages_generated/instance/CHANGELOG.md @@ -3,6 +3,20 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.4.0 (2025-10-29) + +### Bug Fixes + +- **instance:** expose the attaching state to help the Console team ([#2412](https://github.com/scaleway/scaleway-sdk-js/issues/2412)) ([36fadc9](https://github.com/scaleway/scaleway-sdk-js/commit/36fadc9d6803c8dc8de0c7159623abedf7de6c25)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **instance:** add field zone for PrivateNIC/PrivateNetwork ([#2521](https://github.com/scaleway/scaleway-sdk-js/issues/2521)) ([14a52b1](https://github.com/scaleway/scaleway-sdk-js/commit/14a52b1350ef6d24be41266355ab84462045f2b0)) +- **instance:** add release IP to IPAM endpoint ([#2394](https://github.com/scaleway/scaleway-sdk-js/issues/2394)) ([32ebc5c](https://github.com/scaleway/scaleway-sdk-js/commit/32ebc5c9530ced7a81a53974c3a5509b2769851a)) +- **instance:** create MigrateVolume method ([#2257](https://github.com/scaleway/scaleway-sdk-js/issues/2257)) ([4b10007](https://github.com/scaleway/scaleway-sdk-js/commit/4b10007738ce676e6d8909af60aa9b5666739f3e)) +- **instance:** updated data field and new RPC ([#2411](https://github.com/scaleway/scaleway-sdk-js/issues/2411)) ([a38963c](https://github.com/scaleway/scaleway-sdk-js/commit/a38963cb721043e0c467469fd84affffdaac64b0)) + # 1.3.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/instance/README.md b/packages_generated/instance/README.md new file mode 100644 index 000000000..a9ed59732 --- /dev/null +++ b/packages_generated/instance/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-instance + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-instance.svg)](https://www.npmjs.com/package/@scaleway/sdk-instance) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-instance.svg)](https://www.npmjs.com/package/@scaleway/sdk-instance) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-instance.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Instance 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-instance @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-instance @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-instance @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 { Instance } from '@scaleway/sdk-instance' + +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 Instance.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 { Instance } from '@scaleway/sdk-instance' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Instance.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Instance API Documentation](https://www.scaleway.com/en/developers/api/instance/) +- πŸ“– [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. + diff --git a/packages_generated/instance/package.json b/packages_generated/instance/package.json index 4be20e043..476064390 100644 --- a/packages_generated/instance/package.json +++ b/packages_generated/instance/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-instance", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK instance", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/interlink/CHANGELOG.md b/packages_generated/interlink/CHANGELOG.md index 17858a4b8..48024d4a7 100644 --- a/packages_generated/interlink/CHANGELOG.md +++ b/packages_generated/interlink/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.4.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-interlink@1.2.0...@scaleway/sdk-interlink@1.4.0) (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **interlink:** add display_name for pops ([#2528](https://github.com/scaleway/scaleway-sdk-js/issues/2528)) ([6d47490](https://github.com/scaleway/scaleway-sdk-js/commit/6d474906097a6f2f011675389a6ba0fb4cda5465)) +- **interlink:** align routing_policy behavior with S2S_VPN ([#2398](https://github.com/scaleway/scaleway-sdk-js/issues/2398)) ([8c2303e](https://github.com/scaleway/scaleway-sdk-js/commit/8c2303e94c833168f5c20fe9ff5f6aa77b2ece57)) + # [1.3.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-interlink@1.2.0...@scaleway/sdk-interlink@1.3.0) (2025-10-22) ### Features diff --git a/packages_generated/interlink/README.md b/packages_generated/interlink/README.md new file mode 100644 index 000000000..5ea2a36ce --- /dev/null +++ b/packages_generated/interlink/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-interlink + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-interlink.svg)](https://www.npmjs.com/package/@scaleway/sdk-interlink) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-interlink.svg)](https://www.npmjs.com/package/@scaleway/sdk-interlink) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-interlink.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Interlink 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-interlink @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-interlink @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-interlink @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 { Interlink } from '@scaleway/sdk-interlink' + +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 Interlink.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 { Interlink } from '@scaleway/sdk-interlink' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Interlink.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Interlink API Documentation](https://www.scaleway.com/en/developers/api/interlink/) +- πŸ“– [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. + diff --git a/packages_generated/interlink/package.json b/packages_generated/interlink/package.json index ff1e0c7cb..985a2d49d 100644 --- a/packages_generated/interlink/package.json +++ b/packages_generated/interlink/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-interlink", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK interlink", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/iot/CHANGELOG.md b/packages_generated/iot/CHANGELOG.md index d22c766ed..8f3adaa6c 100644 --- a/packages_generated/iot/CHANGELOG.md +++ b/packages_generated/iot/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- add support for region in iot resources ([#2453](https://github.com/scaleway/scaleway-sdk-js/issues/2453)) ([66f2ab2](https://github.com/scaleway/scaleway-sdk-js/commit/66f2ab2c524369d38fcb9ee3434034fe1d6360f0)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/iot/README.md b/packages_generated/iot/README.md new file mode 100644 index 000000000..cc6101c85 --- /dev/null +++ b/packages_generated/iot/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-iot + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-iot.svg)](https://www.npmjs.com/package/@scaleway/sdk-iot) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-iot.svg)](https://www.npmjs.com/package/@scaleway/sdk-iot) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-iot.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Iot 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-iot @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-iot @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-iot @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 { Iot } from '@scaleway/sdk-iot' + +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 Iot.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 { Iot } from '@scaleway/sdk-iot' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Iot.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Iot API Documentation](https://www.scaleway.com/en/developers/api/iot/) +- πŸ“– [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. + diff --git a/packages_generated/iot/package.json b/packages_generated/iot/package.json index 19f9373c8..ddd8c66aa 100644 --- a/packages_generated/iot/package.json +++ b/packages_generated/iot/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-iot", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK iot", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/ipam/CHANGELOG.md b/packages_generated/ipam/CHANGELOG.md index abcf0d335..5e0c64554 100644 --- a/packages_generated/ipam/CHANGELOG.md +++ b/packages_generated/ipam/CHANGELOG.md @@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.5.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **ipam:** add scaleblock searchdb cluster ([#2317](https://github.com/scaleway/scaleway-sdk-js/issues/2317)) ([652228e](https://github.com/scaleway/scaleway-sdk-js/commit/652228eed6dab6b2168ea8ab61d71cbee137eb7d)) +- **ipam:** make ips and macs sortable ([#2258](https://github.com/scaleway/scaleway-sdk-js/issues/2258)) ([47ebb47](https://github.com/scaleway/scaleway-sdk-js/commit/47ebb4799905a568c9706c4e979e7f612042c4f6)) + # 1.4.0 (2025-10-22) ### Features diff --git a/packages_generated/ipam/README.md b/packages_generated/ipam/README.md new file mode 100644 index 000000000..e6c6f7ad7 --- /dev/null +++ b/packages_generated/ipam/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-ipam + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-ipam.svg)](https://www.npmjs.com/package/@scaleway/sdk-ipam) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-ipam.svg)](https://www.npmjs.com/package/@scaleway/sdk-ipam) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-ipam.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Ipam 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-ipam @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-ipam @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-ipam @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 { Ipam } from '@scaleway/sdk-ipam' + +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 Ipam.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 { Ipam } from '@scaleway/sdk-ipam' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Ipam.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Ipam API Documentation](https://www.scaleway.com/en/developers/api/ipam/) +- πŸ“– [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. + diff --git a/packages_generated/ipam/package.json b/packages_generated/ipam/package.json index 4bc1a1f04..d1df9ab27 100644 --- a/packages_generated/ipam/package.json +++ b/packages_generated/ipam/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-ipam", - "version": "1.4.0", + "version": "1.5.0", "description": "Scaleway SDK ipam", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/jobs/CHANGELOG.md b/packages_generated/jobs/CHANGELOG.md index 583a6a267..b669ad10c 100644 --- a/packages_generated/jobs/CHANGELOG.md +++ b/packages_generated/jobs/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.2.0 (2025-10-22) ### Features diff --git a/packages_generated/jobs/README.md b/packages_generated/jobs/README.md new file mode 100644 index 000000000..db78a804b --- /dev/null +++ b/packages_generated/jobs/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-jobs + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-jobs.svg)](https://www.npmjs.com/package/@scaleway/sdk-jobs) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-jobs.svg)](https://www.npmjs.com/package/@scaleway/sdk-jobs) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-jobs.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Jobs 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-jobs @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-jobs @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-jobs @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 { Jobs } from '@scaleway/sdk-jobs' + +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 Jobs.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 { Jobs } from '@scaleway/sdk-jobs' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Jobs.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Jobs API Documentation](https://www.scaleway.com/en/developers/api/jobs/) +- πŸ“– [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. + diff --git a/packages_generated/jobs/package.json b/packages_generated/jobs/package.json index 1c726deaf..75865cef4 100644 --- a/packages_generated/jobs/package.json +++ b/packages_generated/jobs/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-jobs", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK jobs", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/k8s/CHANGELOG.md b/packages_generated/k8s/CHANGELOG.md index 1f535bd13..c6ed062d5 100644 --- a/packages_generated/k8s/CHANGELOG.md +++ b/packages_generated/k8s/CHANGELOG.md @@ -3,6 +3,24 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.8.0 (2025-10-29) + +### Bug Fixes + +- **k8s:** change installer_tags to repeated string with unique validation ([#2231](https://github.com/scaleway/scaleway-sdk-js/issues/2231)) ([d2955f2](https://github.com/scaleway/scaleway-sdk-js/commit/d2955f211efd951f1664a8af30cf73ed7251200c)) +- **k8s:** fix typo export index.gen.ts ([#2474](https://github.com/scaleway/scaleway-sdk-js/issues/2474)) ([5716934](https://github.com/scaleway/scaleway-sdk-js/commit/5716934decae46c94b370a19d98e1add9bd6d5c4)) +- read real exports from packages instead of guessing names to fix TypeScript compilation errors ([#2460](https://github.com/scaleway/scaleway-sdk-js/issues/2460)) ([c8c424e](https://github.com/scaleway/scaleway-sdk-js/commit/c8c424e09d3a365a2592f25abdc0a8d6d86e0f0b)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **k8s:** add cilium_native cni for native routing mode ([#2404](https://github.com/scaleway/scaleway-sdk-js/issues/2404)) ([63cd890](https://github.com/scaleway/scaleway-sdk-js/commit/63cd8906723b260c417810631bc9526384292430)) +- **k8s:** add k8s version release date ([#2495](https://github.com/scaleway/scaleway-sdk-js/issues/2495)) ([a077177](https://github.com/scaleway/scaleway-sdk-js/commit/a077177a6d40df0486f02f521a55885a3fb3dd32)) +- **k8s:** add node metadata fields for provider and updater ([#2226](https://github.com/scaleway/scaleway-sdk-js/issues/2226)) ([6292c4a](https://github.com/scaleway/scaleway-sdk-js/commit/6292c4a90c71fbacbe0719280e858e726330a220)) +- **k8s:** add template_args field to NodeMetadata ([#2414](https://github.com/scaleway/scaleway-sdk-js/issues/2414)) ([d1e745a](https://github.com/scaleway/scaleway-sdk-js/commit/d1e745a8760cdd95de614b1895f23e5d3e46c91b)) +- **k8s:** add versions deprecation+eol dates ([#2445](https://github.com/scaleway/scaleway-sdk-js/issues/2445)) ([3b6457d](https://github.com/scaleway/scaleway-sdk-js/commit/3b6457d0b5976d73f71c42cf48c8be1430249fed)) +- **k8s:** support setting PodCidr, ServiceCidr, and ServiceDNSIP during cluster creation ([#2273](https://github.com/scaleway/scaleway-sdk-js/issues/2273)) ([4bc32ae](https://github.com/scaleway/scaleway-sdk-js/commit/4bc32ae469b35281ea9196f8984d5b6a716c3b1c)) + # 1.7.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/k8s/README.md b/packages_generated/k8s/README.md new file mode 100644 index 000000000..f082dac0d --- /dev/null +++ b/packages_generated/k8s/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-k8s + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-k8s.svg)](https://www.npmjs.com/package/@scaleway/sdk-k8s) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-k8s.svg)](https://www.npmjs.com/package/@scaleway/sdk-k8s) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-k8s.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for K8S 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-k8s @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-k8s @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-k8s @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 { K8S } from '@scaleway/sdk-k8s' + +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 K8S.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 { K8S } from '@scaleway/sdk-k8s' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new K8S.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway K8S API Documentation](https://www.scaleway.com/en/developers/api/k8s/) +- πŸ“– [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. + diff --git a/packages_generated/k8s/package.json b/packages_generated/k8s/package.json index 4e0321a7e..65ce6e780 100644 --- a/packages_generated/k8s/package.json +++ b/packages_generated/k8s/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-k8s", - "version": "1.7.0", + "version": "1.8.0", "description": "Scaleway SDK k8s", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/key_manager/CHANGELOG.md b/packages_generated/key_manager/CHANGELOG.md index b1dded325..65da4c49c 100644 --- a/packages_generated/key_manager/CHANGELOG.md +++ b/packages_generated/key_manager/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.5.0 (2025-10-29) + +### Bug Fixes + +- **key_manager:** add scheduled_for_deletion state ([#2246](https://github.com/scaleway/scaleway-sdk-js/issues/2246)) ([7a35cdb](https://github.com/scaleway/scaleway-sdk-js/commit/7a35cdb2d2540b0dc9ab716fa7093549c60db23b)) + +### Features + +- **key_manager:** add api to list algorithms ([#2330](https://github.com/scaleway/scaleway-sdk-js/issues/2330)) ([933e1ea](https://github.com/scaleway/scaleway-sdk-js/commit/933e1ea0bd5b5501792ccb647944d1d1004bb87d)) +- **key_manager:** update doc with asymmetric usage ([#2392](https://github.com/scaleway/scaleway-sdk-js/issues/2392)) ([2ba3308](https://github.com/scaleway/scaleway-sdk-js/commit/2ba3308d8e598856f9a79671170f7dec552454fc)) + # 1.4.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/key_manager/README.md b/packages_generated/key_manager/README.md new file mode 100644 index 000000000..ab4f54680 --- /dev/null +++ b/packages_generated/key_manager/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-key-manager + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-key-manager.svg)](https://www.npmjs.com/package/@scaleway/sdk-key-manager) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-key-manager.svg)](https://www.npmjs.com/package/@scaleway/sdk-key-manager) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-key-manager.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Key Manager 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-key-manager @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-key-manager @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-key-manager @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 { KeyManager } from '@scaleway/sdk-key-manager' + +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 KeyManager.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 { KeyManager } from '@scaleway/sdk-key-manager' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new KeyManager.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Key Manager API Documentation](https://www.scaleway.com/en/developers/api/key-manager/) +- πŸ“– [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. + diff --git a/packages_generated/key_manager/package.json b/packages_generated/key_manager/package.json index cb8f86227..77ffda33c 100644 --- a/packages_generated/key_manager/package.json +++ b/packages_generated/key_manager/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-key-manager", - "version": "1.4.0", + "version": "1.5.0", "description": "Scaleway SDK key-manager", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/lb/CHANGELOG.md b/packages_generated/lb/CHANGELOG.md index 74da26655..d0ce338f8 100644 --- a/packages_generated/lb/CHANGELOG.md +++ b/packages_generated/lb/CHANGELOG.md @@ -3,6 +3,17 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.4.0 (2025-10-29) + +### Bug Fixes + +- **lb:** deny whitespace on uri field ([#2256](https://github.com/scaleway/scaleway-sdk-js/issues/2256)) ([65d413c](https://github.com/scaleway/scaleway-sdk-js/commit/65d413ca7b8ffc73ee476c21dd8df99ab78bbd2e)) +- **lb:** remove whitespace regex uri ([#2461](https://github.com/scaleway/scaleway-sdk-js/issues/2461)) ([b9ec922](https://github.com/scaleway/scaleway-sdk-js/commit/b9ec9223752a3d5337baf5d1f820ab48b380de3b)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.3.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/lb/README.md b/packages_generated/lb/README.md new file mode 100644 index 000000000..0133a9fab --- /dev/null +++ b/packages_generated/lb/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-lb + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-lb.svg)](https://www.npmjs.com/package/@scaleway/sdk-lb) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-lb.svg)](https://www.npmjs.com/package/@scaleway/sdk-lb) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-lb.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Lb 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-lb @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-lb @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-lb @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 { Lb } from '@scaleway/sdk-lb' + +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 Lb.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 { Lb } from '@scaleway/sdk-lb' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Lb.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Lb API Documentation](https://www.scaleway.com/en/developers/api/lb/) +- πŸ“– [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. + diff --git a/packages_generated/lb/package.json b/packages_generated/lb/package.json index 85abda81b..a5488cd57 100644 --- a/packages_generated/lb/package.json +++ b/packages_generated/lb/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-lb", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK lb", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/marketplace/CHANGELOG.md b/packages_generated/marketplace/CHANGELOG.md index 02d795073..cae64d80d 100644 --- a/packages_generated/marketplace/CHANGELOG.md +++ b/packages_generated/marketplace/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **marketplace:** add support for `arch` in `ListLocalImagesRequest` ([#2372](https://github.com/scaleway/scaleway-sdk-js/issues/2372)) ([1e39223](https://github.com/scaleway/scaleway-sdk-js/commit/1e39223684931597753762188f64ad697e944747)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/marketplace/README.md b/packages_generated/marketplace/README.md new file mode 100644 index 000000000..8a0b32056 --- /dev/null +++ b/packages_generated/marketplace/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-marketplace + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-marketplace.svg)](https://www.npmjs.com/package/@scaleway/sdk-marketplace) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-marketplace.svg)](https://www.npmjs.com/package/@scaleway/sdk-marketplace) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-marketplace.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Marketplace 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-marketplace @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-marketplace @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-marketplace @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 { Marketplace } from '@scaleway/sdk-marketplace' + +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 Marketplace.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 { Marketplace } from '@scaleway/sdk-marketplace' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Marketplace.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Marketplace API Documentation](https://www.scaleway.com/en/developers/api/marketplace/) +- πŸ“– [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. + diff --git a/packages_generated/marketplace/package.json b/packages_generated/marketplace/package.json index a68f6091b..8536f2fa5 100644 --- a/packages_generated/marketplace/package.json +++ b/packages_generated/marketplace/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-marketplace", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK marketplace", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/mnq/CHANGELOG.md b/packages_generated/mnq/CHANGELOG.md index 436d6df7b..dc9b2a813 100644 --- a/packages_generated/mnq/CHANGELOG.md +++ b/packages_generated/mnq/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **mnq:** add region in NatsCredentials message ([#2451](https://github.com/scaleway/scaleway-sdk-js/issues/2451)) ([eb12ad8](https://github.com/scaleway/scaleway-sdk-js/commit/eb12ad8942a1e90d18032b69176540bcc862263e)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/mnq/README.md b/packages_generated/mnq/README.md new file mode 100644 index 000000000..eab48098a --- /dev/null +++ b/packages_generated/mnq/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-mnq + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-mnq.svg)](https://www.npmjs.com/package/@scaleway/sdk-mnq) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-mnq.svg)](https://www.npmjs.com/package/@scaleway/sdk-mnq) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-mnq.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Mnq 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-mnq @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-mnq @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-mnq @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 { Mnq } from '@scaleway/sdk-mnq' + +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 Mnq.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 { Mnq } from '@scaleway/sdk-mnq' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Mnq.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Mnq API Documentation](https://www.scaleway.com/en/developers/api/mnq/) +- πŸ“– [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. + diff --git a/packages_generated/mnq/package.json b/packages_generated/mnq/package.json index 18e3b007f..9011fa81c 100644 --- a/packages_generated/mnq/package.json +++ b/packages_generated/mnq/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-mnq", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK mnq", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/mongodb/CHANGELOG.md b/packages_generated/mongodb/CHANGELOG.md index d1f173860..2d211c84b 100644 --- a/packages_generated/mongodb/CHANGELOG.md +++ b/packages_generated/mongodb/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.4.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-mongodb@1.1.0...@scaleway/sdk-mongodb@1.4.0) (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **mongodb:** add list databases route ([#2274](https://github.com/scaleway/scaleway-sdk-js/issues/2274)) ([17935b3](https://github.com/scaleway/scaleway-sdk-js/commit/17935b36a29da90b4e66101c7c7a6c5a0047a4c2)) + # [1.3.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-mongodb@1.1.0...@scaleway/sdk-mongodb@1.3.0) (2025-10-22) ### Features diff --git a/packages_generated/mongodb/README.md b/packages_generated/mongodb/README.md new file mode 100644 index 000000000..11826f85d --- /dev/null +++ b/packages_generated/mongodb/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-mongodb + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-mongodb.svg)](https://www.npmjs.com/package/@scaleway/sdk-mongodb) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-mongodb.svg)](https://www.npmjs.com/package/@scaleway/sdk-mongodb) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-mongodb.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Mongodb 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-mongodb @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-mongodb @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-mongodb @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 { Mongodb } from '@scaleway/sdk-mongodb' + +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 Mongodb.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 { Mongodb } from '@scaleway/sdk-mongodb' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Mongodb.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Mongodb API Documentation](https://www.scaleway.com/en/developers/api/mongodb/) +- πŸ“– [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. + diff --git a/packages_generated/mongodb/package.json b/packages_generated/mongodb/package.json index 3129edf33..30f49ac8e 100644 --- a/packages_generated/mongodb/package.json +++ b/packages_generated/mongodb/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-mongodb", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK mongodb", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/product_catalog/CHANGELOG.md b/packages_generated/product_catalog/CHANGELOG.md index 357d20392..0463a2e50 100644 --- a/packages_generated/product_catalog/CHANGELOG.md +++ b/packages_generated/product_catalog/CHANGELOG.md @@ -3,6 +3,20 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.9.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **baremetal:** expose zone for offers and os ([#2496](https://github.com/scaleway/scaleway-sdk-js/issues/2496)) ([47f4e16](https://github.com/scaleway/scaleway-sdk-js/commit/47f4e16eea9f55281e62ec85455b6ffd92d9fd43)) +- **product_catalog:** add new boolean to ignore unsupported variants ([#2253](https://github.com/scaleway/scaleway-sdk-js/issues/2253)) ([4569b7f](https://github.com/scaleway/scaleway-sdk-js/commit/4569b7f2291e95cf9944248f08aa0e2385d7b264)) +- **product_catalog:** add new product status end of sale ([#2306](https://github.com/scaleway/scaleway-sdk-js/issues/2306)) ([367ce21](https://github.com/scaleway/scaleway-sdk-js/commit/367ce210462494eb104731ea5896d150a6e664d3)) +- **product_catalog:** add offer ID in the public/admin catalog API ([#2337](https://github.com/scaleway/scaleway-sdk-js/issues/2337)) ([6c4a499](https://github.com/scaleway/scaleway-sdk-js/commit/6c4a4999eb5b4cf2f7770e5d0436812996b9bd9f)) +- **product_catalog:** add productCategory ([#2350](https://github.com/scaleway/scaleway-sdk-js/issues/2350)) ([b0d384a](https://github.com/scaleway/scaleway-sdk-js/commit/b0d384afc7621322a9fb389845a80cb81a6195c5)) +- **product_catalog:** add support for `second` as a countable unit ([#2375](https://github.com/scaleway/scaleway-sdk-js/issues/2375)) ([d0a5542](https://github.com/scaleway/scaleway-sdk-js/commit/d0a5542cb25a306f259a2e3f693faadeaa3a4508)) +- **product_catalog:** handle new countable units in catalog APIs ([#2383](https://github.com/scaleway/scaleway-sdk-js/issues/2383)) ([f06ff7b](https://github.com/scaleway/scaleway-sdk-js/commit/f06ff7bcbbd7f68a65c87ae72356556bd27d1a44)) +- **product_catalog:** object storage to estimation api ([#2316](https://github.com/scaleway/scaleway-sdk-js/issues/2316)) ([7431191](https://github.com/scaleway/scaleway-sdk-js/commit/74311914f9dbe4030cbb3b90cc40822bbd41f056)) + # 1.8.0 (2025-10-22) ### Features diff --git a/packages_generated/product_catalog/README.md b/packages_generated/product_catalog/README.md new file mode 100644 index 000000000..6c0ba955b --- /dev/null +++ b/packages_generated/product_catalog/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-product-catalog + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-product-catalog.svg)](https://www.npmjs.com/package/@scaleway/sdk-product-catalog) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-product-catalog.svg)](https://www.npmjs.com/package/@scaleway/sdk-product-catalog) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-product-catalog.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Product Catalog 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-product-catalog @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-product-catalog @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-product-catalog @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 { ProductCatalog } from '@scaleway/sdk-product-catalog' + +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 ProductCatalog.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 { ProductCatalog } from '@scaleway/sdk-product-catalog' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new ProductCatalog.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Product Catalog API Documentation](https://www.scaleway.com/en/developers/api/product-catalog/) +- πŸ“– [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. + diff --git a/packages_generated/product_catalog/package.json b/packages_generated/product_catalog/package.json index ac7a2b4e5..6ffe3a1a8 100644 --- a/packages_generated/product_catalog/package.json +++ b/packages_generated/product_catalog/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-product-catalog", - "version": "1.8.0", + "version": "1.9.0", "description": "Scaleway SDK product-catalog", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/qaas/CHANGELOG.md b/packages_generated/qaas/CHANGELOG.md index efb9c5c92..ad51a9bac 100644 --- a/packages_generated/qaas/CHANGELOG.md +++ b/packages_generated/qaas/CHANGELOG.md @@ -3,6 +3,16 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# [1.5.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-qaas@1.2.0...@scaleway/sdk-qaas@1.5.0) (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **qaas:** add booking req param ([#2430](https://github.com/scaleway/scaleway-sdk-js/issues/2430)) ([57f2c6a](https://github.com/scaleway/scaleway-sdk-js/commit/57f2c6a4574e512a387b2dbf9e175f2a6c361da4)) +- **qaas:** add model messages ([#2310](https://github.com/scaleway/scaleway-sdk-js/issues/2310)) ([f89e805](https://github.com/scaleway/scaleway-sdk-js/commit/f89e8054ce4cacf239f377ef9b2b4e79831131a7)) +- **qaas:** add session parameters ([#2341](https://github.com/scaleway/scaleway-sdk-js/issues/2341)) ([505b6ac](https://github.com/scaleway/scaleway-sdk-js/commit/505b6ace84d8e12dba80bfd685e3569edc1ce588)) +- **qaas:** add tz for booking ([#2522](https://github.com/scaleway/scaleway-sdk-js/issues/2522)) ([7ebd448](https://github.com/scaleway/scaleway-sdk-js/commit/7ebd4487ebe50ae4c2f9509e5390a6d2434cca2c)) + # [1.4.0](https://github.com/scaleway/scaleway-sdk-js/compare/@scaleway/sdk-qaas@1.2.0...@scaleway/sdk-qaas@1.4.0) (2025-10-22) ### Features diff --git a/packages_generated/qaas/README.md b/packages_generated/qaas/README.md new file mode 100644 index 000000000..487c54c39 --- /dev/null +++ b/packages_generated/qaas/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-qaas + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-qaas.svg)](https://www.npmjs.com/package/@scaleway/sdk-qaas) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-qaas.svg)](https://www.npmjs.com/package/@scaleway/sdk-qaas) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-qaas.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Qaas 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-qaas @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-qaas @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-qaas @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 { Qaas } from '@scaleway/sdk-qaas' + +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 Qaas.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 { Qaas } from '@scaleway/sdk-qaas' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Qaas.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Qaas API Documentation](https://www.scaleway.com/en/developers/api/qaas/) +- πŸ“– [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. + diff --git a/packages_generated/qaas/package.json b/packages_generated/qaas/package.json index 0169e2265..220112b29 100644 --- a/packages_generated/qaas/package.json +++ b/packages_generated/qaas/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-qaas", - "version": "1.4.0", + "version": "1.5.0", "description": "Scaleway SDK qaas", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/rdb/CHANGELOG.md b/packages_generated/rdb/CHANGELOG.md index 462499234..8f0392e79 100644 --- a/packages_generated/rdb/CHANGELOG.md +++ b/packages_generated/rdb/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **rdb:** add skip_size_retrieval option to ListDatabases endpoint ([#2456](https://github.com/scaleway/scaleway-sdk-js/issues/2456)) ([a64b907](https://github.com/scaleway/scaleway-sdk-js/commit/a64b9075dddf95c2f103dd06ef5f2b8989a69702)) + # 1.2.0 (2025-10-22) ### Features diff --git a/packages_generated/rdb/README.md b/packages_generated/rdb/README.md new file mode 100644 index 000000000..6b54edde5 --- /dev/null +++ b/packages_generated/rdb/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-rdb + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-rdb.svg)](https://www.npmjs.com/package/@scaleway/sdk-rdb) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-rdb.svg)](https://www.npmjs.com/package/@scaleway/sdk-rdb) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-rdb.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Rdb 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-rdb @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-rdb @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-rdb @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 { Rdb } from '@scaleway/sdk-rdb' + +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 Rdb.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 { Rdb } from '@scaleway/sdk-rdb' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Rdb.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Rdb API Documentation](https://www.scaleway.com/en/developers/api/rdb/) +- πŸ“– [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. + diff --git a/packages_generated/rdb/package.json b/packages_generated/rdb/package.json index bc3f59e47..2ffec0cc1 100644 --- a/packages_generated/rdb/package.json +++ b/packages_generated/rdb/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-rdb", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK rdb", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/redis/CHANGELOG.md b/packages_generated/redis/CHANGELOG.md index 923c4c9db..5a2e1ae7b 100644 --- a/packages_generated/redis/CHANGELOG.md +++ b/packages_generated/redis/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/redis/README.md b/packages_generated/redis/README.md new file mode 100644 index 000000000..46e8b96b7 --- /dev/null +++ b/packages_generated/redis/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-redis + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-redis.svg)](https://www.npmjs.com/package/@scaleway/sdk-redis) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-redis.svg)](https://www.npmjs.com/package/@scaleway/sdk-redis) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-redis.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Redis 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-redis @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-redis @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-redis @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 { Redis } from '@scaleway/sdk-redis' + +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 Redis.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 { Redis } from '@scaleway/sdk-redis' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Redis.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Redis API Documentation](https://www.scaleway.com/en/developers/api/redis/) +- πŸ“– [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. + diff --git a/packages_generated/redis/package.json b/packages_generated/redis/package.json index 9121aca85..0cea9f7d6 100644 --- a/packages_generated/redis/package.json +++ b/packages_generated/redis/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-redis", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK redis", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/registry/CHANGELOG.md b/packages_generated/registry/CHANGELOG.md index 5c5200aca..f8fe23003 100644 --- a/packages_generated/registry/CHANGELOG.md +++ b/packages_generated/registry/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/registry/README.md b/packages_generated/registry/README.md new file mode 100644 index 000000000..a129f5342 --- /dev/null +++ b/packages_generated/registry/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-registry + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-registry.svg)](https://www.npmjs.com/package/@scaleway/sdk-registry) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-registry.svg)](https://www.npmjs.com/package/@scaleway/sdk-registry) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-registry.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Registry 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-registry @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-registry @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-registry @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 { Registry } from '@scaleway/sdk-registry' + +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 Registry.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 { Registry } from '@scaleway/sdk-registry' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Registry.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Registry API Documentation](https://www.scaleway.com/en/developers/api/registry/) +- πŸ“– [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. + diff --git a/packages_generated/registry/package.json b/packages_generated/registry/package.json index 130285054..15e79ca74 100644 --- a/packages_generated/registry/package.json +++ b/packages_generated/registry/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-registry", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK registry", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/s2s_vpn/CHANGELOG.md b/packages_generated/s2s_vpn/CHANGELOG.md index 9b134e902..c2eb4c85b 100644 --- a/packages_generated/s2s_vpn/CHANGELOG.md +++ b/packages_generated/s2s_vpn/CHANGELOG.md @@ -3,6 +3,19 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Bug Fixes + +- read real exports from packages instead of guessing names to fix TypeScript compilation errors ([#2460](https://github.com/scaleway/scaleway-sdk-js/issues/2460)) ([c8c424e](https://github.com/scaleway/scaleway-sdk-js/commit/c8c424e09d3a365a2592f25abdc0a8d6d86e0f0b)) +- **s2s_vpn:** add packages ([#2400](https://github.com/scaleway/scaleway-sdk-js/issues/2400)) ([5703403](https://github.com/scaleway/scaleway-sdk-js/commit/5703403f87dccf9e7f6d8e52c278608c440a6dca)) +- **s2s_vpn:** make connections object ip version–specific ([#2418](https://github.com/scaleway/scaleway-sdk-js/issues/2418)) ([de42af9](https://github.com/scaleway/scaleway-sdk-js/commit/de42af9866db9956511368ee003ec7eaa8f5eec4)) + +### Features + +- **s2s_vpn:** accept custom private interco IPs on connection creation ([#2482](https://github.com/scaleway/scaleway-sdk-js/issues/2482)) ([8f0d10f](https://github.com/scaleway/scaleway-sdk-js/commit/8f0d10ffd98b02bccf1be14024c7b92c52f413fd)) +- **s2s_vpn:** use secret manager to store connection psk ([#2539](https://github.com/scaleway/scaleway-sdk-js/issues/2539)) ([30abbbe](https://github.com/scaleway/scaleway-sdk-js/commit/30abbbe7adbf3494fff1200c7527a35520529e54)) + # 1.1.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/s2s_vpn/README.md b/packages_generated/s2s_vpn/README.md new file mode 100644 index 000000000..2c905c417 --- /dev/null +++ b/packages_generated/s2s_vpn/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-s2s-vpn + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-s2s-vpn.svg)](https://www.npmjs.com/package/@scaleway/sdk-s2s-vpn) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-s2s-vpn.svg)](https://www.npmjs.com/package/@scaleway/sdk-s2s-vpn) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-s2s-vpn.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for S2S Vpn 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-s2s-vpn @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-s2s-vpn @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-s2s-vpn @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 { S2SVpn } from '@scaleway/sdk-s2s-vpn' + +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 S2SVpn.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 { S2SVpn } from '@scaleway/sdk-s2s-vpn' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new S2SVpn.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway S2S Vpn API Documentation](https://www.scaleway.com/en/developers/api/s2s-vpn/) +- πŸ“– [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. + diff --git a/packages_generated/s2s_vpn/package.json b/packages_generated/s2s_vpn/package.json index 6d352fda9..3716a004a 100644 --- a/packages_generated/s2s_vpn/package.json +++ b/packages_generated/s2s_vpn/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-s2s-vpn", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK s2s-vpn", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/secret/CHANGELOG.md b/packages_generated/secret/CHANGELOG.md index 405901572..3aae25922 100644 --- a/packages_generated/secret/CHANGELOG.md +++ b/packages_generated/secret/CHANGELOG.md @@ -3,6 +3,13 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.4.0 (2025-10-29) + +### Features + +- **secret_manager:** add s2s_vpn to product ([#2536](https://github.com/scaleway/scaleway-sdk-js/issues/2536)) ([91c927f](https://github.com/scaleway/scaleway-sdk-js/commit/91c927fe7082e44a3439023de0a5aed6fc456d53)) +- **secret_manager:** add the region of the version ([#2505](https://github.com/scaleway/scaleway-sdk-js/issues/2505)) ([b526f49](https://github.com/scaleway/scaleway-sdk-js/commit/b526f49be9bd40cd040e175752e5e9c4a064eb4a)) + # 1.3.0 (2025-10-22) ### Features diff --git a/packages_generated/secret/README.md b/packages_generated/secret/README.md new file mode 100644 index 000000000..49b63ef3c --- /dev/null +++ b/packages_generated/secret/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-secret + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-secret.svg)](https://www.npmjs.com/package/@scaleway/sdk-secret) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-secret.svg)](https://www.npmjs.com/package/@scaleway/sdk-secret) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-secret.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Secret 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-secret @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-secret @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-secret @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 { Secret } from '@scaleway/sdk-secret' + +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 Secret.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 { Secret } from '@scaleway/sdk-secret' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Secret.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Secret API Documentation](https://www.scaleway.com/en/developers/api/secret/) +- πŸ“– [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. + diff --git a/packages_generated/secret/package.json b/packages_generated/secret/package.json index f43514459..51d153f05 100644 --- a/packages_generated/secret/package.json +++ b/packages_generated/secret/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-secret", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK secret", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/serverless_sqldb/CHANGELOG.md b/packages_generated/serverless_sqldb/CHANGELOG.md index 06d64f57a..a3cee98d1 100644 --- a/packages_generated/serverless_sqldb/CHANGELOG.md +++ b/packages_generated/serverless_sqldb/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/serverless_sqldb/README.md b/packages_generated/serverless_sqldb/README.md new file mode 100644 index 000000000..4fa5e8d3d --- /dev/null +++ b/packages_generated/serverless_sqldb/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-serverless-sqldb + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-serverless-sqldb.svg)](https://www.npmjs.com/package/@scaleway/sdk-serverless-sqldb) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-serverless-sqldb.svg)](https://www.npmjs.com/package/@scaleway/sdk-serverless-sqldb) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-serverless-sqldb.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Serverless Sqldb 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-serverless-sqldb @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-serverless-sqldb @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-serverless-sqldb @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 { ServerlessSqldb } from '@scaleway/sdk-serverless-sqldb' + +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 ServerlessSqldb.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 { ServerlessSqldb } from '@scaleway/sdk-serverless-sqldb' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new ServerlessSqldb.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Serverless Sqldb API Documentation](https://www.scaleway.com/en/developers/api/serverless-sqldb/) +- πŸ“– [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. + diff --git a/packages_generated/serverless_sqldb/package.json b/packages_generated/serverless_sqldb/package.json index bdbda24ed..85ca51529 100644 --- a/packages_generated/serverless_sqldb/package.json +++ b/packages_generated/serverless_sqldb/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-serverless-sqldb", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK serverless-sqldb", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/std/CHANGELOG.md b/packages_generated/std/CHANGELOG.md index 3d2d22833..2ccbeb28e 100644 --- a/packages_generated/std/CHANGELOG.md +++ b/packages_generated/std/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- **audit_trail:** add authentication events in public API ([#2374](https://github.com/scaleway/scaleway-sdk-js/issues/2374)) ([9ca66aa](https://github.com/scaleway/scaleway-sdk-js/commit/9ca66aa435e2bdfdd8e1dffd78a90e44d140a343)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/std/package.json b/packages_generated/std/package.json index b41d2391e..55504c271 100644 --- a/packages_generated/std/package.json +++ b/packages_generated/std/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-std", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK Std", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/tem/CHANGELOG.md b/packages_generated/tem/CHANGELOG.md index 19dcf8940..e5a8e4a40 100644 --- a/packages_generated/tem/CHANGELOG.md +++ b/packages_generated/tem/CHANGELOG.md @@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.3.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **tem:** add dkim, spf and mx records in domain message ([#2417](https://github.com/scaleway/scaleway-sdk-js/issues/2417)) ([9a08609](https://github.com/scaleway/scaleway-sdk-js/commit/9a08609649d0130794ee67a4b16a18d1c2490486)) +- **tem:** add max subject len in email creation ([#2227](https://github.com/scaleway/scaleway-sdk-js/issues/2227)) ([495e94f](https://github.com/scaleway/scaleway-sdk-js/commit/495e94f6041ca0e7acf197e16eb4e8ede0dc733b)) +- **tem:** add mx records validation in get domain last status ([#2409](https://github.com/scaleway/scaleway-sdk-js/issues/2409)) ([05b2f56](https://github.com/scaleway/scaleway-sdk-js/commit/05b2f56148f84990c45d3d9eed538bd4949fcd45)) + # 1.2.0 (2025-10-22) ### Features diff --git a/packages_generated/tem/README.md b/packages_generated/tem/README.md new file mode 100644 index 000000000..6a8913052 --- /dev/null +++ b/packages_generated/tem/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-tem + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-tem.svg)](https://www.npmjs.com/package/@scaleway/sdk-tem) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-tem.svg)](https://www.npmjs.com/package/@scaleway/sdk-tem) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-tem.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Tem 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-tem @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-tem @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-tem @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 { Tem } from '@scaleway/sdk-tem' + +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 Tem.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 { Tem } from '@scaleway/sdk-tem' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Tem.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Tem API Documentation](https://www.scaleway.com/en/developers/api/tem/) +- πŸ“– [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. + diff --git a/packages_generated/tem/package.json b/packages_generated/tem/package.json index 73d3b4e8b..cbedddcd4 100644 --- a/packages_generated/tem/package.json +++ b/packages_generated/tem/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-tem", - "version": "1.2.0", + "version": "1.3.0", "description": "Scaleway SDK tem", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/test/CHANGELOG.md b/packages_generated/test/CHANGELOG.md index cc3631fc0..13884ee0b 100644 --- a/packages_generated/test/CHANGELOG.md +++ b/packages_generated/test/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/test/README.md b/packages_generated/test/README.md new file mode 100644 index 000000000..a67899e79 --- /dev/null +++ b/packages_generated/test/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-test + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-test.svg)](https://www.npmjs.com/package/@scaleway/sdk-test) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-test.svg)](https://www.npmjs.com/package/@scaleway/sdk-test) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-test.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Test 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-test @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-test @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-test @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 { Test } from '@scaleway/sdk-test' + +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 Test.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 { Test } from '@scaleway/sdk-test' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Test.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Test API Documentation](https://www.scaleway.com/en/developers/api/test/) +- πŸ“– [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. + diff --git a/packages_generated/test/package.json b/packages_generated/test/package.json index 9e8bab6ee..c05c76236 100644 --- a/packages_generated/test/package.json +++ b/packages_generated/test/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-test", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK test", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/vpc/CHANGELOG.md b/packages_generated/vpc/CHANGELOG.md index 074efb2f9..ccee69f78 100644 --- a/packages_generated/vpc/CHANGELOG.md +++ b/packages_generated/vpc/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.4.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.3.0 (2025-10-22) ### Features diff --git a/packages_generated/vpc/README.md b/packages_generated/vpc/README.md new file mode 100644 index 000000000..df2b00d8f --- /dev/null +++ b/packages_generated/vpc/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-vpc + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-vpc.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpc) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-vpc.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpc) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-vpc.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Vpc 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-vpc @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-vpc @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-vpc @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 { Vpc } from '@scaleway/sdk-vpc' + +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 Vpc.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 { Vpc } from '@scaleway/sdk-vpc' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Vpc.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Vpc API Documentation](https://www.scaleway.com/en/developers/api/vpc/) +- πŸ“– [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. + diff --git a/packages_generated/vpc/package.json b/packages_generated/vpc/package.json index 5e6b0af8a..a7f8de2f9 100644 --- a/packages_generated/vpc/package.json +++ b/packages_generated/vpc/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-vpc", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK vpc", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/vpcgw/CHANGELOG.md b/packages_generated/vpcgw/CHANGELOG.md index ecdec12d9..86e8a161e 100644 --- a/packages_generated/vpcgw/CHANGELOG.md +++ b/packages_generated/vpcgw/CHANGELOG.md @@ -3,6 +3,12 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.2.0 (2025-10-29) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) + # 1.1.0 (2025-10-22) ### Features diff --git a/packages_generated/vpcgw/README.md b/packages_generated/vpcgw/README.md new file mode 100644 index 000000000..d954ca54d --- /dev/null +++ b/packages_generated/vpcgw/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-vpcgw + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-vpcgw.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpcgw) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-vpcgw.svg)](https://www.npmjs.com/package/@scaleway/sdk-vpcgw) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-vpcgw.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Vpcgw 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-vpcgw @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-vpcgw @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-vpcgw @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 { Vpcgw } from '@scaleway/sdk-vpcgw' + +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 Vpcgw.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 { Vpcgw } from '@scaleway/sdk-vpcgw' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Vpcgw.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Vpcgw API Documentation](https://www.scaleway.com/en/developers/api/vpcgw/) +- πŸ“– [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. + diff --git a/packages_generated/vpcgw/package.json b/packages_generated/vpcgw/package.json index 647a87d6c..ae2f3966b 100644 --- a/packages_generated/vpcgw/package.json +++ b/packages_generated/vpcgw/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-vpcgw", - "version": "1.1.0", + "version": "1.2.0", "description": "Scaleway SDK vpcgw", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/packages_generated/webhosting/CHANGELOG.md b/packages_generated/webhosting/CHANGELOG.md index 679261903..2ebc75590 100644 --- a/packages_generated/webhosting/CHANGELOG.md +++ b/packages_generated/webhosting/CHANGELOG.md @@ -3,6 +3,25 @@ All notable changes to this project will be documented in this file. See [Conventional Commits](https://conventionalcommits.org) for commit guidelines. +# 1.4.0 (2025-10-29) + +### Bug Fixes + +- read real exports from packages instead of guessing names to fix TypeScript compilation errors ([#2460](https://github.com/scaleway/scaleway-sdk-js/issues/2460)) ([c8c424e](https://github.com/scaleway/scaleway-sdk-js/commit/c8c424e09d3a365a2592f25abdc0a8d6d86e0f0b)) +- **webhosting:** require domain_name on RemoveCustomDomainRequest ([#2385](https://github.com/scaleway/scaleway-sdk-js/issues/2385)) ([6fa61ad](https://github.com/scaleway/scaleway-sdk-js/commit/6fa61ad6ac165ce237629880179e391fc44bbc64)) + +### Features + +- add extension .js for nodenext ([#2492](https://github.com/scaleway/scaleway-sdk-js/issues/2492)) ([592c46d](https://github.com/scaleway/scaleway-sdk-js/commit/592c46df916c5b8b35f26c13b626eee797970f5d)) +- **webhosting:** add custom domain to hosting ([#2312](https://github.com/scaleway/scaleway-sdk-js/issues/2312)) ([9205729](https://github.com/scaleway/scaleway-sdk-js/commit/920572938863202d914eae21fbc89febe3b7402c)) +- **webhosting:** add fields to backup api ([#2511](https://github.com/scaleway/scaleway-sdk-js/issues/2511)) ([fd740e6](https://github.com/scaleway/scaleway-sdk-js/commit/fd740e6ac9101aea8f5a35669836cc85d5c9b1f5)) +- **webhosting:** add free subdomain support ([#2302](https://github.com/scaleway/scaleway-sdk-js/issues/2302)) ([f92fbd0](https://github.com/scaleway/scaleway-sdk-js/commit/f92fbd075c97e76ef7089bd59539522a507c2f39)) +- **webhosting:** add parent zone domain name ([#2243](https://github.com/scaleway/scaleway-sdk-js/issues/2243)) ([ba7c2fe](https://github.com/scaleway/scaleway-sdk-js/commit/ba7c2fec9899b2195a0988865500bbc4dca9a7f2)) +- **webhosting:** add public backup api ([#2307](https://github.com/scaleway/scaleway-sdk-js/issues/2307)) ([1cf1b8f](https://github.com/scaleway/scaleway-sdk-js/commit/1cf1b8fc982e3de0a4b0c7fc3cf20e55f93e5f43)) +- **webhosting:** add the `CreateWebsite` and `DeleteWebsite` endpoints ([#2538](https://github.com/scaleway/scaleway-sdk-js/issues/2538)) ([c5da2b7](https://github.com/scaleway/scaleway-sdk-js/commit/c5da2b785055c6976c56cc56df207cb6911ddfb7)) +- **webhosting:** deprecate CheckUserOwnsDomain endpoint ([#2329](https://github.com/scaleway/scaleway-sdk-js/issues/2329)) ([d4b8598](https://github.com/scaleway/scaleway-sdk-js/commit/d4b85989dad74a78b6fae3ae97b4d7522ab70b15)) +- **webhosting:** implement FreeDomainAPI ([#2373](https://github.com/scaleway/scaleway-sdk-js/issues/2373)) ([50278b2](https://github.com/scaleway/scaleway-sdk-js/commit/50278b2d1e97f90d2641206570dc5b3f60bf3549)) + # 1.3.0 (2025-10-22) ### Bug Fixes diff --git a/packages_generated/webhosting/README.md b/packages_generated/webhosting/README.md new file mode 100644 index 000000000..d264976a2 --- /dev/null +++ b/packages_generated/webhosting/README.md @@ -0,0 +1,96 @@ +# @scaleway/sdk-webhosting + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-webhosting.svg)](https://www.npmjs.com/package/@scaleway/sdk-webhosting) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-webhosting.svg)](https://www.npmjs.com/package/@scaleway/sdk-webhosting) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-webhosting.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for Webhosting 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-webhosting @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-webhosting @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-webhosting @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 { Webhosting } from '@scaleway/sdk-webhosting' + +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 Webhosting.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 { Webhosting } from '@scaleway/sdk-webhosting' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new Webhosting.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway Webhosting API Documentation](https://www.scaleway.com/en/developers/api/webhosting/) +- πŸ“– [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. + diff --git a/packages_generated/webhosting/package.json b/packages_generated/webhosting/package.json index 16aa451e8..8654aba36 100644 --- a/packages_generated/webhosting/package.json +++ b/packages_generated/webhosting/package.json @@ -1,9 +1,10 @@ { "name": "@scaleway/sdk-webhosting", - "version": "1.3.0", + "version": "1.4.0", "description": "Scaleway SDK webhosting", "license": "Apache-2.0", "files": [ + "README.md", "dist" ], "type": "module", diff --git a/scripts/generatePackages.ts b/scripts/generatePackages.ts index a71548317..4e2ea1df5 100644 --- a/scripts/generatePackages.ts +++ b/scripts/generatePackages.ts @@ -14,7 +14,9 @@ import type { ParseArgsConfig } from 'node:util' import { parseArgs } from 'node:util' import { SDKS } from './constants' import { + renderTemplate, renderTemplatePackageJson, + snakeToDisplayName, snakeToPascal, snakeToSlug, } from './helpers' @@ -24,6 +26,7 @@ import { * - package.json * - vite.config.ts * - tsconfig.json + * - README.md */ const TEMPLATES = { @@ -31,9 +34,11 @@ const TEMPLATES = { TS_CONFIG: join(cwd(), 'scripts/templates', 'tsconfig.json'), TS_CONFIG_BUILD: join(cwd(), 'scripts/templates', 'tsconfig.build.json'), VITE_CONFIG: join(cwd(), 'scripts/templates', 'vite.config.ts'), + README: join(cwd(), 'scripts/templates', 'README.tmpl'), } const templateString = readFileSync(TEMPLATES.PACKAGE_JSON, 'utf8') +const readmeTemplateString = readFileSync(TEMPLATES.README, 'utf8') // npx tsx scripts/generatePackages.ts ) --src="packages_generated" const options: ParseArgsConfig['options'] = { @@ -143,6 +148,21 @@ const main = () => { join(fullPath, 'tsconfig.build.json'), ) copyFileSync(TEMPLATES.VITE_CONFIG, join(fullPath, 'vite.config.ts')) + + // Generate README.md only if it doesn't exist + const readmeFilePath = join(fullPath, 'README.md') + access(readmeFilePath, constants.F_OK, err => { + if (err) { + const slugName = snakeToSlug(productDir) + const readme = renderTemplate(readmeTemplateString, { + name: slugName, + displayName: snakeToDisplayName(productDir), + pascalName: snakeToPascal(productDir), + }) + writeFileSync(readmeFilePath, readme) + console.log(`Generated README.md for ${productDir}`) + } + }) } } } diff --git a/scripts/helpers.ts b/scripts/helpers.ts index a12ee2a13..81a01ec62 100644 --- a/scripts/helpers.ts +++ b/scripts/helpers.ts @@ -23,6 +23,26 @@ export const unionTocamelCase = (str: string) => export const snakeToSlug = (str: string) => str.split('_').join('-') +export const snakeToDisplayName = (str: string) => + str + .split('_') + .map(s => handleAcronym(s.split('/').map(handleAcronym).join('/'))) + .join(' ') + +export const renderTemplate = ( + template: string, + params: Record, +): string => { + let result = template + for (const [key, value] of Object.entries(params)) { + const placeholder = `{{${key}}}` + const stringValue = + typeof value === 'object' ? JSON.stringify(value) : value.toString() + result = result.replace(new RegExp(placeholder, 'g'), stringValue) + } + return result +} + export const renderTemplatePackageJson = ( template: string, params: Record, diff --git a/scripts/templates/README.tmpl b/scripts/templates/README.tmpl new file mode 100644 index 000000000..54f716af1 --- /dev/null +++ b/scripts/templates/README.tmpl @@ -0,0 +1,95 @@ +# @scaleway/sdk-{{name}} + +[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-{{name}}.svg)](https://www.npmjs.com/package/@scaleway/sdk-{{name}}) +[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-{{name}}.svg)](https://www.npmjs.com/package/@scaleway/sdk-{{name}}) +[![license](https://img.shields.io/npm/l/@scaleway/sdk-{{name}}.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) + +Scaleway SDK for {{displayName}} 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-{{name}} @scaleway/sdk-client +``` + +or with pnpm: + +```bash +pnpm add @scaleway/sdk-{{name}} @scaleway/sdk-client +``` + +or with yarn: + +```bash +yarn add @scaleway/sdk-{{name}} @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 { {{pascalName}} } from '@scaleway/sdk-{{name}}' + +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 {{pascalName}}.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 { {{pascalName}} } from '@scaleway/sdk-{{name}}' + +const profile = loadProfileFromConfigurationFile() +const client = createClient(profile) +const api = new {{pascalName}}.v1.API(client) +``` + +## Documentation + +- πŸ“š [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js) +- 🌐 [Scaleway {{displayName}} API Documentation](https://www.scaleway.com/en/developers/api/{{name}}/) +- πŸ“– [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. diff --git a/scripts/templates/package.tmpl b/scripts/templates/package.tmpl index 3afb81db6..1927455dd 100644 --- a/scripts/templates/package.tmpl +++ b/scripts/templates/package.tmpl @@ -4,7 +4,8 @@ "description": "Scaleway SDK {{name}}", "license": "Apache-2.0", "files": [ - "dist" + "dist", + "README.md" ], "type": "module", "exports": {