@scaleway/sdk 3.0.0-alpha.0 → 3.1.1

package/package.json

@@ -1,39 +1,85 @@
 {
   "name": "@scaleway/sdk",
-  "version": "3.0.0-alpha.0",
+  "version": "3.1.1",
+  "description": "Scaleway SDK TS.",
   "license": "Apache-2.0",
-  "description": "Scaleway SDK.",
-  "keywords": [
-    "scaleway",
-    "cloud",
-    "sdk"
-  ],
-  "main": "dist/index.cjs",
-  "module": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "version": "./scripts/update-constants-file.sh"
-  },
   "files": [
     "dist"
   ],
-  "publishConfig": {
-    "access": "public"
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.gen.d.ts",
+      "default": "./dist/index.gen.js"
+    }
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/scaleway/scaleway-sdk-js",
-    "directory": "packages/clients"
+    "url": "git+https://github.com/scaleway/scaleway-sdk-js.git",
+    "directory": "packages/sdk"
   },
   "engines": {
-    "node": ">=18.0"
+    "node": ">=20.19.6"
   },
-  "type": "module",
   "dependencies": {
-    "@scaleway/random-name": "^4.0.2"
+    "@scaleway/sdk-applesilicon": "2.1.1",
+    "@scaleway/sdk-account": "2.1.1",
+    "@scaleway/sdk-autoscaling": "2.1.1",
+    "@scaleway/sdk-audit-trail": "2.1.1",
+    "@scaleway/sdk-baremetal": "2.1.1",
+    "@scaleway/sdk-billing": "2.1.1",
+    "@scaleway/sdk-block": "2.1.1",
+    "@scaleway/sdk-client": "^2.1.0",
+    "@scaleway/sdk-container": "2.1.1",
+    "@scaleway/sdk-cockpit": "2.1.1",
+    "@scaleway/sdk-datawarehouse": "2.1.1",
+    "@scaleway/sdk-dedibox": "2.1.1",
+    "@scaleway/sdk-domain": "2.1.1",
+    "@scaleway/sdk-edge-services": "2.1.1",
+    "@scaleway/sdk-environmental-footprint": "2.2.0",
+    "@scaleway/sdk-file": "2.1.1",
+    "@scaleway/sdk-iam": "2.1.1",
+    "@scaleway/sdk-function": "2.1.1",
+    "@scaleway/sdk-inference": "2.1.1",
+    "@scaleway/sdk-interlink": "2.1.1",
+    "@scaleway/sdk-instance": "2.1.1",
+    "@scaleway/sdk-flexibleip": "2.1.1",
+    "@scaleway/sdk-ipam": "2.1.1",
+    "@scaleway/sdk-iot": "2.1.1",
+    "@scaleway/sdk-jobs": "2.1.1",
+    "@scaleway/sdk-k8s": "2.2.0",
+    "@scaleway/sdk-kafka": "2.1.1",
+    "@scaleway/sdk-key-manager": "2.1.1",
+    "@scaleway/sdk-lb": "2.1.1",
+    "@scaleway/sdk-marketplace": "2.1.1",
+    "@scaleway/sdk-mongodb": "2.1.1",
+    "@scaleway/sdk-product-catalog": "2.1.1",
+    "@scaleway/sdk-mnq": "2.1.1",
+    "@scaleway/sdk-qaas": "2.1.1",
+    "@scaleway/sdk-rdb": "2.1.1",
+    "@scaleway/sdk-redis": "2.1.1",
+    "@scaleway/sdk-registry": "2.1.1",
+    "@scaleway/sdk-secret": "2.1.1",
+    "@scaleway/sdk-serverless-sqldb": "2.1.1",
+    "@scaleway/sdk-s2s-vpn": "2.1.1",
+    "@scaleway/sdk-tem": "2.1.1",
+    "@scaleway/sdk-test": "2.1.1",
+    "@scaleway/sdk-vpc": "2.1.1",
+    "@scaleway/sdk-std": "2.1.0",
+    "@scaleway/sdk-vpcgw": "2.1.1",
+    "@scaleway/sdk-webhosting": "2.1.1"
   },
-  "bundledDependencies": [
-    "@scaleway/random-name"
-  ],
-  "gitHead": "28047ea6cbed152dde09cf282a4c957d5ff559ce"
-}
+  "devDependencies": {
+    "@scaleway/sdk-client": "^2.1.0"
+  },
+  "peerDependencies": {
+    "@scaleway/sdk-client": "^2.1.0"
+  },
+  "scripts": {
+    "package:check": "pnpm publint",
+    "typecheck": "tsc --noEmit",
+    "type:generate": "tsc --declaration -p tsconfig.build.json",
+    "build": "vite build --config vite.config.ts && pnpm run type:generate",
+    "build:profile": "npx vite-bundle-visualizer -c vite.config.ts"
+  }
+}

package/README.md

@@ -1,46 +0,0 @@
-# Scaleway SDK
-
-This SDK enables you to interact with Scaleway APIs.
-
-**🔗  Important links:**
-* [Reference documentation](https://scaleway.github.io/scaleway-sdk-js)
-* [Example projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
-* [Developers website](https://developers.scaleway.com) (API documentation)
-
-## 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.
-
-**A minimal setup** would look like this:
-
-```ts
-import { Registry, createClient } from '@scaleway/sdk'
-
-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)
-```
-
-**For a simpler setup**, you could retrieve the profile from either the configuration file or the environment variables:
-
-```ts
-import { 
-  loadProfileFromConfigurationFile, 
-  // loadProfileFromEnvironmentValues,
-} from '@scaleway/configuration-loader'
-
-const profile = loadProfileFromConfigurationFile() // loadProfileFromEnvironmentValues()
-const client = createClient(profile)
-```
-
-**For more information**, please check the [GitHub project](https://github.com/scaleway/scaleway-sdk-js).
-
-## Reach us
-
-We love feedback. Feel free to reach us on [Scaleway Slack community](https://slack.scaleway.com/), we are waiting for you on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource).

package/dist/api/account/index.js

@@ -1,4 +0,0 @@
-import * as index_gen from './v2/index.gen.js';
-export { index_gen as v2 };
-import * as index_gen$1 from './v3/index.gen.js';
-export { index_gen$1 as v3 };

package/dist/api/account/v2/api.gen.js

@@ -1,147 +0,0 @@
-import { API as API$1 } from '../../../scw/api.js';
-import { urlParams, validatePathParam } from '../../../helpers/marshalling.js';
-import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
-import { marshalCreateProjectRequest, unmarshalProject, unmarshalListProjectsResponse, marshalUpdateProjectRequest } from './marshalling.gen.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-const jsonContentHeaders = {
-  'Content-Type': 'application/json; charset=utf-8'
-};
-
-/**
- * Account API.
- *
- * User related data. This API allows you to manage projects.
- */
-class API extends API$1 {
-  /**
-   * Create a new Project for an Organization. Deprecated in favor of Account
-   * API v3. Generate a new Project for an Organization, specifying its
-   * configuration including name and description.
-   *
-   * @deprecated
-   * @param request - The request {@link CreateProjectRequest}
-   * @returns A Promise of Project
-   */
-  createProject = (() => {
-    var _this = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this.client.fetch({
-        body: JSON.stringify(marshalCreateProjectRequest(request, _this.client.settings)),
-        headers: jsonContentHeaders,
-        method: 'POST',
-        path: `/account/v2/projects`
-      }, unmarshalProject);
-    };
-  })();
-  pageOfListProjects = (() => {
-    var _this2 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this2.client.fetch({
-        method: 'GET',
-        path: `/account/v2/projects`,
-        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy], ['organization_id', request.organizationId ?? _this2.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this2.client.settings.defaultPageSize], ['project_ids', request.projectIds])
-      }, unmarshalListProjectsResponse);
-    };
-  })();
-
-  /**
-   * List all Projects of an Organization. Deprecated in favor of Account API
-   * v3. List all Projects of an Organization. The response will include the
-   * total number of Projects as well as their associated Organizations, names
-   * and IDs. Other information include the creation and update date of the
-   * Project.
-   *
-   * @deprecated
-   * @param request - The request {@link ListProjectsRequest}
-   * @returns A Promise of ListProjectsResponse
-   */
-  listProjects = (() => {
-    var _this3 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return enrichForPagination('projects', _this3.pageOfListProjects, request);
-    };
-  })();
-
-  /**
-   * Get an existing Project. Deprecated in favor of Account API v3. Retrieve
-   * information about an existing Project, specified by its Project ID. Its
-   * full details, including ID, name and description, are returned in the
-   * response object.
-   *
-   * @deprecated
-   * @param request - The request {@link GetProjectRequest}
-   * @returns A Promise of Project
-   */
-  getProject = (() => {
-    var _this4 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this4.client.fetch({
-        method: 'GET',
-        path: `/account/v2/projects/${validatePathParam('projectId', request.projectId ?? _this4.client.settings.defaultProjectId)}`
-      }, unmarshalProject);
-    };
-  })();
-
-  /**
-   * Delete an existing Project. Deprecated in favor of Account API v3. Delete
-   * an existing Project, specified by its Project ID. The Project needs to be
-   * empty (meaning there are no resources left in it) to be deleted
-   * effectively. Note that deleting a Project is permanent, and cannot be
-   * undone.
-   *
-   * @deprecated
-   * @param request - The request {@link DeleteProjectRequest}
-   */
-  deleteProject = (() => {
-    var _this5 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this5.client.fetch({
-        method: 'DELETE',
-        path: `/account/v2/projects/${validatePathParam('projectId', request.projectId ?? _this5.client.settings.defaultProjectId)}`
-      });
-    };
-  })();
-
-  /**
-   * Update Project. Deprecated in favor of Account API v3. Update the
-   * parameters of an existing Project, specified by its Project ID. These
-   * parameters include the name and description.
-   *
-   * @deprecated
-   * @param request - The request {@link UpdateProjectRequest}
-   * @returns A Promise of Project
-   */
-  updateProject = (() => {
-    var _this6 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this6.client.fetch({
-        body: JSON.stringify(marshalUpdateProjectRequest(request, _this6.client.settings)),
-        headers: jsonContentHeaders,
-        method: 'PATCH',
-        path: `/account/v2/projects/${validatePathParam('projectId', request.projectId ?? _this6.client.settings.defaultProjectId)}`
-      }, unmarshalProject);
-    };
-  })();
-}
-
-export { API };

package/dist/api/account/v2/index.gen.js

@@ -1,4 +0,0 @@
-export { API } from './api.gen.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.

package/dist/api/account/v2/marshalling.gen.js

@@ -1,39 +0,0 @@
-import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@4.0.2/node_modules/@scaleway/random-name/dist/index.js';
-import { isJSONObject } from '../../../helpers/json.js';
-import { unmarshalDate, unmarshalArrayOfObject } from '../../../helpers/marshalling.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-const unmarshalProject = data => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'Project' failed as data isn't a dictionary.`);
-  }
-  return {
-    createdAt: unmarshalDate(data.created_at),
-    description: data.description,
-    id: data.id,
-    name: data.name,
-    organizationId: data.organization_id,
-    updatedAt: unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalListProjectsResponse = data => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ListProjectsResponse' failed as data isn't a dictionary.`);
-  }
-  return {
-    projects: unmarshalArrayOfObject(data.projects, unmarshalProject),
-    totalCount: data.total_count
-  };
-};
-const marshalCreateProjectRequest = (request, defaults) => ({
-  description: request.description,
-  name: request.name || randomName('proj'),
-  organization_id: request.organizationId ?? defaults.defaultOrganizationId
-});
-const marshalUpdateProjectRequest = (request, defaults) => ({
-  description: request.description,
-  name: request.name
-});
-
-export { marshalCreateProjectRequest, marshalUpdateProjectRequest, unmarshalListProjectsResponse, unmarshalProject };

package/dist/api/account/v3/api.gen.js

@@ -1,129 +0,0 @@
-import { API as API$1 } from '../../../scw/api.js';
-import { urlParams, validatePathParam } from '../../../helpers/marshalling.js';
-import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
-import { marshalProjectApiCreateProjectRequest, unmarshalProject, unmarshalListProjectsResponse, marshalProjectApiUpdateProjectRequest } from './marshalling.gen.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-const jsonContentHeaders = {
-  'Content-Type': 'application/json; charset=utf-8'
-};
-
-/**
- * Account API.
- *
- * This API allows you to manage projects.
- */
-class ProjectAPI extends API$1 {
-  /**
-   * Create a new Project for an Organization. Generate a new Project for an
-   * Organization, specifying its configuration including name and description.
-   *
-   * @param request - The request {@link ProjectApiCreateProjectRequest}
-   * @returns A Promise of Project
-   */
-  createProject = request => this.client.fetch({
-    body: JSON.stringify(marshalProjectApiCreateProjectRequest(request, this.client.settings)),
-    headers: jsonContentHeaders,
-    method: 'POST',
-    path: `/account/v3/projects`
-  }, unmarshalProject);
-  pageOfListProjects = (() => {
-    var _this = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this.client.fetch({
-        method: 'GET',
-        path: `/account/v3/projects`,
-        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_ids', request.projectIds])
-      }, unmarshalListProjectsResponse);
-    };
-  })();
-
-  /**
-   * List all Projects of an Organization. List all Projects of an Organization.
-   * The response will include the total number of Projects as well as their
-   * associated Organizations, names, and IDs. Other information includes the
-   * creation and update date of the Project.
-   *
-   * @param request - The request {@link ProjectApiListProjectsRequest}
-   * @returns A Promise of ListProjectsResponse
-   */
-  listProjects = (() => {
-    var _this2 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return enrichForPagination('projects', _this2.pageOfListProjects, request);
-    };
-  })();
-
-  /**
-   * Get an existing Project. Retrieve information about an existing Project,
-   * specified by its Project ID. Its full details, including ID, name and
-   * description, are returned in the response object.
-   *
-   * @param request - The request {@link ProjectApiGetProjectRequest}
-   * @returns A Promise of Project
-   */
-  getProject = (() => {
-    var _this3 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this3.client.fetch({
-        method: 'GET',
-        path: `/account/v3/projects/${validatePathParam('projectId', request.projectId ?? _this3.client.settings.defaultProjectId)}`
-      }, unmarshalProject);
-    };
-  })();
-
-  /**
-   * Delete an existing Project. Delete an existing Project, specified by its
-   * Project ID. The Project needs to be empty (meaning there are no resources
-   * left in it) to be deleted effectively. Note that deleting a Project is
-   * permanent, and cannot be undone.
-   *
-   * @param request - The request {@link ProjectApiDeleteProjectRequest}
-   */
-  deleteProject = (() => {
-    var _this4 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this4.client.fetch({
-        method: 'DELETE',
-        path: `/account/v3/projects/${validatePathParam('projectId', request.projectId ?? _this4.client.settings.defaultProjectId)}`
-      });
-    };
-  })();
-
-  /**
-   * Update Project. Update the parameters of an existing Project, specified by
-   * its Project ID. These parameters include the name and description.
-   *
-   * @param request - The request {@link ProjectApiUpdateProjectRequest}
-   * @returns A Promise of Project
-   */
-  updateProject = (() => {
-    var _this5 = this;
-    return function (request) {
-      if (request === void 0) {
-        request = {};
-      }
-      return _this5.client.fetch({
-        body: JSON.stringify(marshalProjectApiUpdateProjectRequest(request, _this5.client.settings)),
-        headers: jsonContentHeaders,
-        method: 'PATCH',
-        path: `/account/v3/projects/${validatePathParam('projectId', request.projectId ?? _this5.client.settings.defaultProjectId)}`
-      }, unmarshalProject);
-    };
-  })();
-}
-
-export { ProjectAPI };

package/dist/api/account/v3/index.gen.js

@@ -1,6 +0,0 @@
-export { ProjectAPI } from './api.gen.js';
-import * as validationRules_gen from './validation-rules.gen.js';
-export { validationRules_gen as ValidationRules };
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.

package/dist/api/account/v3/marshalling.gen.js

@@ -1,39 +0,0 @@
-import randomName from '../../../node_modules/.pnpm/@scaleway_random-name@4.0.2/node_modules/@scaleway/random-name/dist/index.js';
-import { isJSONObject } from '../../../helpers/json.js';
-import { unmarshalDate, unmarshalArrayOfObject } from '../../../helpers/marshalling.js';
-
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-const unmarshalProject = data => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'Project' failed as data isn't a dictionary.`);
-  }
-  return {
-    createdAt: unmarshalDate(data.created_at),
-    description: data.description,
-    id: data.id,
-    name: data.name,
-    organizationId: data.organization_id,
-    updatedAt: unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalListProjectsResponse = data => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ListProjectsResponse' failed as data isn't a dictionary.`);
-  }
-  return {
-    projects: unmarshalArrayOfObject(data.projects, unmarshalProject),
-    totalCount: data.total_count
-  };
-};
-const marshalProjectApiCreateProjectRequest = (request, defaults) => ({
-  description: request.description,
-  name: request.name || randomName('proj'),
-  organization_id: request.organizationId ?? defaults.defaultOrganizationId
-});
-const marshalProjectApiUpdateProjectRequest = (request, defaults) => ({
-  description: request.description,
-  name: request.name
-});
-
-export { marshalProjectApiCreateProjectRequest, marshalProjectApiUpdateProjectRequest, unmarshalListProjectsResponse, unmarshalProject };

package/dist/api/account/v3/validation-rules.gen.js

@@ -1,39 +0,0 @@
-// This file was automatically generated. DO NOT EDIT.
-// If you have any remark or suggestion do not hesitate to open an issue.
-
-const ProjectApiCreateProjectRequest = {
-  description: {
-    maxLength: 200
-  },
-  name: {
-    maxLength: 64,
-    minLength: 1,
-    pattern: /^[a-zA-Z0-9\._\- ]+$/
-  }
-};
-const ProjectApiListProjectsRequest = {
-  name: {
-    maxLength: 64,
-    minLength: 1,
-    pattern: /^[a-zA-Z0-9\._\- ]+$/
-  },
-  page: {
-    greaterThan: 0
-  },
-  pageSize: {
-    greaterThanOrEqual: 1,
-    lessThanOrEqual: 100
-  }
-};
-const ProjectApiUpdateProjectRequest = {
-  description: {
-    maxLength: 200
-  },
-  name: {
-    maxLength: 64,
-    minLength: 1,
-    pattern: /^[a-zA-Z0-9\._\- ]+$/
-  }
-};
-
-export { ProjectApiCreateProjectRequest, ProjectApiListProjectsRequest, ProjectApiUpdateProjectRequest };

package/dist/api/applesilicon/index.js

@@ -1,2 +0,0 @@
-import * as index_gen from './v1alpha1/index.gen.js';
-export { index_gen as v1alpha1 };