@scaleway/sdk-test 1.1.0 → 2.1.1

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

package/dist/v1/api.gen.d.ts

@@ -1,5 +1,5 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { WaitForOptions } from '@scaleway/sdk-client';
+import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { CreateHumanRequest, DeleteHumanRequest, GetHumanRequest, Human, ListHumansRequest, ListHumansResponse, RegisterRequest, RegisterResponse, RunHumanRequest, SmokeHumanRequest, UpdateHumanRequest } from './types.gen.js';
 /**
  * Fake API.

package/dist/v1/api.gen.js

@@ -32,10 +32,7 @@ class API extends API$1 {
         ["order_by", request.orderBy],
         ["organization_id", request.organizationId],
         ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
+        ["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
         ["project_id", request.projectId]
       )
     },

package/dist/v1/content.gen.js

@@ -1,4 +1,6 @@
-const HUMAN_TRANSIENT_STATUSES = ["running"];
+const HUMAN_TRANSIENT_STATUSES = [
+  "running"
+];
 export {
   HUMAN_TRANSIENT_STATUSES
 };

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

@@ -1,4 +1,4 @@
-export { API } from './api.gen.js';
+export { API, } from './api.gen.js';
 export * from './content.gen.js';
 export * from './marshalling.gen.js';
 export type { CreateHumanRequest, DeleteHumanRequest, EyeColors, GetHumanRequest, Human, HumanStatus, ListHumansRequest, ListHumansRequestOrderBy, ListHumansResponse, RegisterRequest, RegisterResponse, RunHumanRequest, SmokeHumanRequest, UpdateHumanRequest, } from './types.gen.js';

package/package.json

@@ -1,23 +1,20 @@
 {
   "name": "@scaleway/sdk-test",
-  "version": "1.1.0",
+  "version": "2.1.1",
   "description": "Scaleway SDK test",
   "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/test"
   },
   "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("./v1/index.gen.cjs");
-exports.Testv1 = index_gen;

package/dist/v1/api.gen.cjs

@@ -1,158 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const content_gen = require("./content.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends sdkClient.API {
-  /**
-     * Register a user. Register a human and return a access-key and a secret-key that must be used in all other commands.
-  
-  Hint: you can use other test commands by setting the SCW_SECRET_KEY env variable.
-     *
-     * @param request - The request {@link RegisterRequest}
-     * @returns A Promise of RegisterResponse
-     */
-  register = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalRegisterRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/test/v1/register`
-    },
-    marshalling_gen.unmarshalRegisterResponse
-  );
-  pageOfListHumans = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/test/v1/humans`,
-      urlParams: sdkClient.urlParams(
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId]
-      )
-    },
-    marshalling_gen.unmarshalListHumansResponse
-  );
-  /**
-   * List all your humans.
-   *
-   * @param request - The request {@link ListHumansRequest}
-   * @returns A Promise of ListHumansResponse
-   */
-  listHumans = (request = {}) => sdkClient.enrichForPagination("humans", this.pageOfListHumans, request);
-  /**
-   * Get human details. Get the human details associated with the given id.
-   *
-   * @param request - The request {@link GetHumanRequest}
-   * @returns A Promise of Human
-   */
-  getHuman = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/test/v1/humans/${sdkClient.validatePathParam("humanId", request.humanId)}`
-    },
-    marshalling_gen.unmarshalHuman
-  );
-  /**
-   * Waits for {@link Human} to be in a final state.
-   *
-   * @param request - The request {@link GetHumanRequest}
-   * @param options - The waiting options
-   * @returns A Promise of Human
-   */
-  waitForHuman = (request, options) => sdkClient.waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(!content_gen.HUMAN_TRANSIENT_STATUSES.includes(res.status))),
-    this.getHuman,
-    request,
-    options
-  );
-  /**
-   * Create a new human.
-   *
-   * @param request - The request {@link CreateHumanRequest}
-   * @returns A Promise of Human
-   */
-  createHuman = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateHumanRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/test/v1/humans`
-    },
-    marshalling_gen.unmarshalHuman
-  );
-  /**
-   * Update an existing human. Update the human associated with the given id.
-   *
-   * @param request - The request {@link UpdateHumanRequest}
-   * @returns A Promise of Human
-   */
-  updateHuman = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalUpdateHumanRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/test/v1/humans/${sdkClient.validatePathParam("humanId", request.humanId)}`
-    },
-    marshalling_gen.unmarshalHuman
-  );
-  /**
-   * Delete an existing human. Delete the human associated with the given id.
-   *
-   * @param request - The request {@link DeleteHumanRequest}
-   * @returns A Promise of Human
-   */
-  deleteHuman = (request) => this.client.fetch(
-    {
-      method: "DELETE",
-      path: `/test/v1/humans/${sdkClient.validatePathParam("humanId", request.humanId)}`
-    },
-    marshalling_gen.unmarshalHuman
-  );
-  /**
-   * Start a 1h running for the given human. Start a one hour running for the given human.
-   *
-   * @param request - The request {@link RunHumanRequest}
-   * @returns A Promise of Human
-   */
-  runHuman = (request) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/test/v1/humans/${sdkClient.validatePathParam("humanId", request.humanId)}/run`
-    },
-    marshalling_gen.unmarshalHuman
-  );
-  /**
-   * Make a human smoke.
-   *
-   * @deprecated
-   * @param request - The request {@link SmokeHumanRequest}
-   * @returns A Promise of Human
-   */
-  smokeHuman = (request) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/test/v1/humans/${sdkClient.validatePathParam("humanId", request.humanId)}/smoke`
-    },
-    marshalling_gen.unmarshalHuman
-  );
-}
-exports.API = API;

package/dist/v1/content.gen.cjs

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const HUMAN_TRANSIENT_STATUSES = ["running"];
-exports.HUMAN_TRANSIENT_STATUSES = HUMAN_TRANSIENT_STATUSES;

package/dist/v1/index.gen.cjs

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const content_gen = require("./content.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-exports.API = api_gen.API;
-exports.HUMAN_TRANSIENT_STATUSES = content_gen.HUMAN_TRANSIENT_STATUSES;
-exports.marshalCreateHumanRequest = marshalling_gen.marshalCreateHumanRequest;
-exports.marshalRegisterRequest = marshalling_gen.marshalRegisterRequest;
-exports.marshalUpdateHumanRequest = marshalling_gen.marshalUpdateHumanRequest;
-exports.unmarshalHuman = marshalling_gen.unmarshalHuman;
-exports.unmarshalListHumansResponse = marshalling_gen.unmarshalListHumansResponse;
-exports.unmarshalRegisterResponse = marshalling_gen.unmarshalRegisterResponse;

package/dist/v1/marshalling.gen.cjs

@@ -1,92 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-const unmarshalHuman = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Human' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    altitudeInMeter: data.altitude_in_meter,
-    altitudeInMillimeter: data.altitude_in_millimeter,
-    createdAt: sdkClient.unmarshalDate(data.created_at),
-    eyesColor: data.eyes_color,
-    fingersCount: data.fingers_count,
-    hairCount: data.hair_count,
-    height: data.height,
-    id: data.id,
-    isHappy: data.is_happy,
-    name: data.name,
-    organizationId: data.organization_id,
-    projectId: data.project_id,
-    shoeSize: data.shoe_size,
-    status: data.status,
-    updatedAt: sdkClient.unmarshalDate(data.updated_at)
-  };
-};
-const unmarshalListHumansResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ListHumansResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    humans: sdkClient.unmarshalArrayOfObject(data.humans, unmarshalHuman),
-    totalCount: data.total_count
-  };
-};
-const unmarshalRegisterResponse = (data) => {
-  if (!sdkClient.isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'RegisterResponse' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    accessKey: data.access_key,
-    secretKey: data.secret_key
-  };
-};
-const marshalCreateHumanRequest = (request, defaults) => ({
-  altitude_in_meter: request.altitudeInMeter,
-  altitude_in_millimeter: request.altitudeInMillimeter,
-  eyes_color: request.eyesColor,
-  fingers_count: request.fingersCount,
-  hair_count: request.hairCount,
-  height: request.height,
-  is_happy: request.isHappy,
-  name: request.name,
-  shoe_size: request.shoeSize,
-  ...sdkClient.resolveOneOf([
-    {
-      default: defaults.defaultProjectId,
-      param: "project_id",
-      value: request.projectId
-    },
-    {
-      default: defaults.defaultOrganizationId,
-      param: "organization_id",
-      value: request.organizationId
-    }
-  ])
-});
-const marshalRegisterRequest = (request, defaults) => ({
-  username: request.username
-});
-const marshalUpdateHumanRequest = (request, defaults) => ({
-  altitude_in_meter: request.altitudeInMeter,
-  altitude_in_millimeter: request.altitudeInMillimeter,
-  eyes_color: request.eyesColor,
-  fingers_count: request.fingersCount,
-  hair_count: request.hairCount,
-  height: request.height,
-  is_happy: request.isHappy,
-  name: request.name,
-  shoe_size: request.shoeSize
-});
-exports.marshalCreateHumanRequest = marshalCreateHumanRequest;
-exports.marshalRegisterRequest = marshalRegisterRequest;
-exports.marshalUpdateHumanRequest = marshalUpdateHumanRequest;
-exports.unmarshalHuman = unmarshalHuman;
-exports.unmarshalListHumansResponse = unmarshalListHumansResponse;
-exports.unmarshalRegisterResponse = unmarshalRegisterResponse;