@scaleway/sdk-marketplace 1.1.0 → 2.1.1

package/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.
+

package/dist/v2/api.gen.js

@@ -11,10 +11,7 @@ class API extends API$1 {
         ["include_eol", request.includeEol],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListImagesResponse
@@ -47,10 +44,7 @@ class API extends API$1 {
         ["image_id", request.imageId],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListVersionsResponse
@@ -83,19 +77,23 @@ class API extends API$1 {
         ["arch", request.arch],
         ["order_by", request.orderBy],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["type", request.type],
         ["zone", request.zone],
-        ...Object.entries(
-          resolveOneOf([
-            { param: "image_id", value: request.imageId },
-            { param: "version_id", value: request.versionId },
-            { param: "image_label", value: request.imageLabel }
-          ])
-        )
+        ...Object.entries(resolveOneOf([
+          {
+            param: "image_id",
+            value: request.imageId
+          },
+          {
+            param: "version_id",
+            value: request.versionId
+          },
+          {
+            param: "image_label",
+            value: request.imageLabel
+          }
+        ]))
       )
     },
     unmarshalListLocalImagesResponse
@@ -126,10 +124,7 @@ class API extends API$1 {
       path: `/marketplace/v2/categories`,
       urlParams: urlParams(
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
       )
     },
     unmarshalListCategoriesResponse

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

@@ -1,3 +1,3 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './marshalling.gen.js';
 export type { Category, GetCategoryRequest, GetImageRequest, GetLocalImageRequest, GetVersionRequest, Image, ListCategoriesRequest, ListCategoriesResponse, ListImagesRequest, ListImagesRequestOrderBy, ListImagesResponse, ListLocalImagesRequest, ListLocalImagesRequestOrderBy, ListLocalImagesResponse, ListVersionsRequest, ListVersionsRequestOrderBy, ListVersionsResponse, LocalImage, LocalImageType, Version, } from './types.gen.js';

package/package.json

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

package/dist/index.gen.cjs

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

package/dist/v2/api.gen.cjs

@@ -1,160 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const marshalling_gen = require("./marshalling.gen.cjs");
-class API extends sdkClient.API {
-  pageOfListImages = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/marketplace/v2/images`,
-      urlParams: sdkClient.urlParams(
-        ["arch", request.arch],
-        ["category", request.category],
-        ["include_eol", request.includeEol],
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
-      )
-    },
-    marshalling_gen.unmarshalListImagesResponse
-  );
-  /**
-   * List marketplace images. List all available images on the marketplace, their UUID, CPU architecture and description.
-   *
-   * @param request - The request {@link ListImagesRequest}
-   * @returns A Promise of ListImagesResponse
-   */
-  listImages = (request) => sdkClient.enrichForPagination("images", this.pageOfListImages, request);
-  /**
-   * Get a specific marketplace image. Get detailed information about a marketplace image, specified by its `image_id` (UUID format).
-   *
-   * @param request - The request {@link GetImageRequest}
-   * @returns A Promise of Image
-   */
-  getImage = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/marketplace/v2/images/${sdkClient.validatePathParam("imageId", request.imageId)}`
-    },
-    marshalling_gen.unmarshalImage
-  );
-  pageOfListVersions = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/marketplace/v2/versions`,
-      urlParams: sdkClient.urlParams(
-        ["image_id", request.imageId],
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
-      )
-    },
-    marshalling_gen.unmarshalListVersionsResponse
-  );
-  /**
-   * List versions of an Image. Get a list of all available version of an image, specified by its `image_id` (UUID format).
-   *
-   * @param request - The request {@link ListVersionsRequest}
-   * @returns A Promise of ListVersionsResponse
-   */
-  listVersions = (request) => sdkClient.enrichForPagination("versions", this.pageOfListVersions, request);
-  /**
-   * Get a specific image version. Get information such as the name, creation date, last update and published date for an image version specified by its `version_id` (UUID format).
-   *
-   * @param request - The request {@link GetVersionRequest}
-   * @returns A Promise of Version
-   */
-  getVersion = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/marketplace/v2/versions/${sdkClient.validatePathParam("versionId", request.versionId)}`
-    },
-    marshalling_gen.unmarshalVersion
-  );
-  pageOfListLocalImages = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/marketplace/v2/local-images`,
-      urlParams: sdkClient.urlParams(
-        ["arch", request.arch],
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["type", request.type],
-        ["zone", request.zone],
-        ...Object.entries(
-          sdkClient.resolveOneOf([
-            { param: "image_id", value: request.imageId },
-            { param: "version_id", value: request.versionId },
-            { param: "image_label", value: request.imageLabel }
-          ])
-        )
-      )
-    },
-    marshalling_gen.unmarshalListLocalImagesResponse
-  );
-  /**
-   * List local images from a specific image or version. List information about local images in a specific Availability Zone, specified by its `image_id` (UUID format), `version_id` (UUID format) or `image_label`. Only one of these three parameters may be set.
-   *
-   * @param request - The request {@link ListLocalImagesRequest}
-   * @returns A Promise of ListLocalImagesResponse
-   */
-  listLocalImages = (request = {}) => sdkClient.enrichForPagination("localImages", this.pageOfListLocalImages, request);
-  /**
-   * Get a specific local image by ID. Get detailed information about a local image, including compatible commercial types, supported architecture, labels and the Availability Zone of the image, specified by its `local_image_id` (UUID format).
-   *
-   * @param request - The request {@link GetLocalImageRequest}
-   * @returns A Promise of LocalImage
-   */
-  getLocalImage = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/marketplace/v2/local-images/${sdkClient.validatePathParam("localImageId", request.localImageId)}`
-    },
-    marshalling_gen.unmarshalLocalImage
-  );
-  pageOfListCategories = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/marketplace/v2/categories`,
-      urlParams: sdkClient.urlParams(
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
-      )
-    },
-    marshalling_gen.unmarshalListCategoriesResponse
-  );
-  /**
-   * List existing image categories. Get a list of all existing categories. The output can be paginated.
-   *
-   * @param request - The request {@link ListCategoriesRequest}
-   * @returns A Promise of ListCategoriesResponse
-   */
-  listCategories = (request = {}) => sdkClient.enrichForPagination("categories", this.pageOfListCategories, request);
-  /**
-   * Get a specific category. Get information about a specific category of the marketplace catalog, specified by its `category_id` (UUID format).
-   *
-   * @param request - The request {@link GetCategoryRequest}
-   * @returns A Promise of Category
-   */
-  getCategory = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/marketplace/v2/categories/${sdkClient.validatePathParam("categoryId", request.categoryId)}`
-    },
-    marshalling_gen.unmarshalCategory
-  );
-}
-exports.API = API;

package/dist/v2/index.gen.cjs

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-exports.API = api_gen.API;
-exports.unmarshalCategory = marshalling_gen.unmarshalCategory;
-exports.unmarshalImage = marshalling_gen.unmarshalImage;
-exports.unmarshalListCategoriesResponse = marshalling_gen.unmarshalListCategoriesResponse;
-exports.unmarshalListImagesResponse = marshalling_gen.unmarshalListImagesResponse;
-exports.unmarshalListLocalImagesResponse = marshalling_gen.unmarshalListLocalImagesResponse;
-exports.unmarshalListVersionsResponse = marshalling_gen.unmarshalListVersionsResponse;
-exports.unmarshalLocalImage = marshalling_gen.unmarshalLocalImage;
-exports.unmarshalVersion = marshalling_gen.unmarshalVersion;

package/dist/v2/marshalling.gen.cjs

@@ -1,114 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const unmarshalCategory = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Category' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    description: data.description,
-    id: data.id,
-    name: data.name
-  };
-};
-const unmarshalImage = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Image' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    categories: data.categories,
-    createdAt: sdkClient.unmarshalDate(data.created_at),
-    description: data.description,
-    id: data.id,
-    label: data.label,
-    logo: data.logo,
-    name: data.name,
-    updatedAt: sdkClient.unmarshalDate(data.updated_at),
-    validUntil: sdkClient.unmarshalDate(data.valid_until)
-  };
-};
-const unmarshalLocalImage = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'LocalImage' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    arch: data.arch,
-    compatibleCommercialTypes: data.compatible_commercial_types,
-    id: data.id,
-    label: data.label,
-    type: data.type,
-    zone: data.zone
-  };
-};
-const unmarshalVersion = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Version' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    createdAt: sdkClient.unmarshalDate(data.created_at),
-    id: data.id,
-    name: data.name,
-    publishedAt: sdkClient.unmarshalDate(data.published_at),
-    updatedAt: sdkClient.unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalListCategoriesResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListCategoriesResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    categories: sdkClient.unmarshalArrayOfObject(data.categories, unmarshalCategory),
-    totalCount: data.total_count
-  };
-};
-const unmarshalListImagesResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListImagesResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    images: sdkClient.unmarshalArrayOfObject(data.images, unmarshalImage),
-    totalCount: data.total_count
-  };
-};
-const unmarshalListLocalImagesResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListLocalImagesResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    localImages: sdkClient.unmarshalArrayOfObject(data.local_images, unmarshalLocalImage),
-    totalCount: data.total_count
-  };
-};
-const unmarshalListVersionsResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListVersionsResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    totalCount: data.total_count,
-    versions: sdkClient.unmarshalArrayOfObject(data.versions, unmarshalVersion)
-  };
-};
-exports.unmarshalCategory = unmarshalCategory;
-exports.unmarshalImage = unmarshalImage;
-exports.unmarshalListCategoriesResponse = unmarshalListCategoriesResponse;
-exports.unmarshalListImagesResponse = unmarshalListImagesResponse;
-exports.unmarshalListLocalImagesResponse = unmarshalListLocalImagesResponse;
-exports.unmarshalListVersionsResponse = unmarshalListVersionsResponse;
-exports.unmarshalLocalImage = unmarshalLocalImage;
-exports.unmarshalVersion = unmarshalVersion;