@scaleway/sdk 2.26.0 → 2.28.0

package/dist/scw/custom-marshalling.js

@@ -1,14 +1,10 @@
-import { isJSONObject } from '../helpers/json.js';
-import { unmarshalDate, unmarshalArrayOfObject } from '../helpers/marshalling.js';
-
-/**
- * Unmarshals {@link Money}
- *
- * @internal
- */
-const unmarshalMoney = data => {
+import { isJSONObject } from "../helpers/json.js";
+import { unmarshalDate, unmarshalArrayOfObject } from "../helpers/marshalling.js";
+const unmarshalMoney = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'Money' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'Money' failed as data isn't a dictionary.`
+    );
   }
   return {
     currencyCode: data.currency_code,
@@ -16,15 +12,11 @@ const unmarshalMoney = data => {
     units: data.units
   };
 };
-
-/**
- * Unmarshals {@link ServiceInfo}.
- *
- * @internal
- */
-const unmarshalServiceInfo = data => {
+const unmarshalServiceInfo = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ServiceInfo' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'ServiceInfo' failed as data isn't a dictionary.`
+    );
   }
   return {
     description: data.description,
@@ -33,15 +25,11 @@ const unmarshalServiceInfo = data => {
     version: data.version
   };
 };
-
-/**
- * Unmarshals {@link ScwFile}.
- *
- * @internal
- */
-const unmarshalScwFile = data => {
+const unmarshalScwFile = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'ScwFile' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'ScwFile' failed as data isn't a dictionary.`
+    );
   }
   return {
     content: data.content,
@@ -49,34 +37,22 @@ const unmarshalScwFile = data => {
     name: data.name
   };
 };
-
-/**
- * Unmarshals {@link TimeSeriesPoint}
- *
- * @remarks To optimize the size of this message,
- * the JSON is compressed in an array instead of a dictionary.
- * Example: `["2019-08-08T15:00:00Z", 0.2]`.
- *
- * @internal
- */
-const unmarshalTimeSeriesPoint = data => {
+const unmarshalTimeSeriesPoint = (data) => {
   if (!Array.isArray(data)) {
-    throw new TypeError(`Unmarshalling the type 'TimeSeriesPoint' failed as data isn't an array.`);
+    throw new TypeError(
+      `Unmarshalling the type 'TimeSeriesPoint' failed as data isn't an array.`
+    );
   }
   return {
     timestamp: unmarshalDate(data[0]),
     value: data[1]
   };
 };
-
-/**
- * Unmarshals {@link TimeSeries}
- *
- * @internal
- */
-const unmarshalTimeSeries = data => {
+const unmarshalTimeSeries = (data) => {
   if (!isJSONObject(data)) {
-    throw new TypeError(`Unmarshalling the type 'TimeSeries' failed as data isn't a dictionary.`);
+    throw new TypeError(
+      `Unmarshalling the type 'TimeSeries' failed as data isn't a dictionary.`
+    );
   }
   return {
     metadata: data.metadata,
@@ -84,48 +60,33 @@ const unmarshalTimeSeries = data => {
     points: unmarshalArrayOfObject(data.points, unmarshalTimeSeriesPoint)
   };
 };
-
-/**
- * Marshals {@link ScwFile}.
- *
- * @internal
- */
-const marshalScwFile = obj => ({
+const marshalScwFile = (obj) => ({
   content: obj.content,
   content_type: obj.contentType,
   name: obj.name
 });
-
-/**
- * Marshals {@link Money}
- *
- * @internal
- */
-const marshalMoney = obj => ({
+const marshalMoney = (obj) => ({
   currency_code: obj.currencyCode,
   nanos: obj.nanos,
   units: obj.units
 });
-
-/**
- * Marshals {@link TimeSeriesPoint}
- *
- * @internal
- */
-const marshalTimeSeriesPoint = obj => ({
+const marshalTimeSeriesPoint = (obj) => ({
   timestamp: obj.timestamp?.toISOString(),
   value: obj.value
 });
-
-/**
- * Marshals {@link TimeSeries}
- *
- * @internal
- */
-const marshalTimeSeries = obj => ({
+const marshalTimeSeries = (obj) => ({
   metadata: obj.metadata,
   name: obj.name,
-  points: obj.points.map(elt => marshalTimeSeriesPoint(elt))
+  points: obj.points.map((elt) => marshalTimeSeriesPoint(elt))
 });
-
-export { marshalMoney, marshalScwFile, marshalTimeSeries, marshalTimeSeriesPoint, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint };
+export {
+  marshalMoney,
+  marshalScwFile,
+  marshalTimeSeries,
+  marshalTimeSeriesPoint,
+  unmarshalMoney,
+  unmarshalScwFile,
+  unmarshalServiceInfo,
+  unmarshalTimeSeries,
+  unmarshalTimeSeriesPoint
+};

package/dist/scw/custom-types.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Represents API metadata.
+ *
+ * @remarks These metadata are only here for debugging. Do not rely on these values.
+ *
+ * @internal
+ */
+export interface ServiceInfo {
+    /** Name of the API */
+    name: string;
+    /** Human readable description for the API. */
+    description: string;
+    /** Version of the API. */
+    version: string;
+    /** Web url where the documentation of the API can be found. */
+    documentationUrl?: string;
+}
+/**
+ * Represents an amount of money with its currency type.
+ */
+export interface Money {
+    /** 3-letter currency code defined in ISO 4217. */
+    currencyCode: string;
+    /**
+     * Whole units of the amount.
+     *
+     * For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+     */
+    units: number;
+    /**
+     * Number of nano (10^-9) units of the amount.
+     *
+     * The value must be between -999,999,999 and +999,999,999 inclusive.
+     * If `units` is positive, `nanos` must be positive or zero.
+     * If `units` is zero, `nanos` can be positive, zero, or negative.
+     * If `units` is negative, `nanos` must be negative or zero.
+     * For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+     */
+    nanos: number;
+}
+/** Represents a point in a TimeSeries. */
+export interface TimeSeriesPoint {
+    /** Date of the point. */
+    timestamp?: Date;
+    /** Value of the point. */
+    value: number;
+}
+/** Represents a time series that could be used for graph purposes. */
+export interface TimeSeries {
+    /** Name of the metric. */
+    name: string;
+    /** Points contains all the points that composed the series. */
+    points: TimeSeriesPoint[];
+    /** Metadata contains some string metadata related to a metric. */
+    metadata: Record<string, string>;
+}
+/** Represents a Scaleway file. */
+export interface ScwFile {
+    /** Name of the file. */
+    name: string;
+    /** Content-type of the file. */
+    contentType: string;
+    /** Content of the file in base64. */
+    content: string;
+}

package/dist/scw/errors/error-parser.cjs

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const invalidRequestMapper = require("./non-standard/invalid-request-mapper.cjs");
+const unknownResourceMapper = require("./non-standard/unknown-resource-mapper.cjs");
+const scwError = require("./scw-error.cjs");
+const alreadyExistsError = require("./standard/already-exists-error.cjs");
+const deniedAuthenticationError = require("./standard/denied-authentication-error.cjs");
+const invalidArgumentsError = require("./standard/invalid-arguments-error.cjs");
+const outOfStockError = require("./standard/out-of-stock-error.cjs");
+const permissionsDeniedError = require("./standard/permissions-denied-error.cjs");
+const preconditionFailedError = require("./standard/precondition-failed-error.cjs");
+const quotasExceededError = require("./standard/quotas-exceeded-error.cjs");
+const resourceExpiredError = require("./standard/resource-expired-error.cjs");
+const resourceLockedError = require("./standard/resource-locked-error.cjs");
+const resourceNotFoundError = require("./standard/resource-not-found-error.cjs");
+const tooManyRequestsError = require("./standard/too-many-requests-error.cjs");
+const transientStateError = require("./standard/transient-state-error.cjs");
+const unmarshalStandardError = (type, status, body) => {
+  let error;
+  switch (type) {
+    case "denied_authentication":
+      error = deniedAuthenticationError.DeniedAuthenticationError;
+      break;
+    case "invalid_arguments":
+      error = invalidArgumentsError.InvalidArgumentsError;
+      break;
+    case "out_of_stock":
+      error = outOfStockError.OutOfStockError;
+      break;
+    case "permissions_denied":
+      error = permissionsDeniedError.PermissionsDeniedError;
+      break;
+    case "precondition_failed":
+      error = preconditionFailedError.PreconditionFailedError;
+      break;
+    case "quotas_exceeded":
+      error = quotasExceededError.QuotasExceededError;
+      break;
+    case "expired":
+      error = resourceExpiredError.ResourceExpiredError;
+      break;
+    case "not_found":
+      error = resourceNotFoundError.ResourceNotFoundError;
+      break;
+    case "locked":
+      error = resourceLockedError.ResourceLockedError;
+      break;
+    case "transient_state":
+      error = transientStateError.TransientStateError;
+      break;
+    case "already_exists":
+      error = alreadyExistsError.AlreadyExistsError;
+      break;
+    case "too_many_requests":
+      error = tooManyRequestsError.TooManyRequestsError;
+      break;
+    default:
+      return null;
+  }
+  return error.fromJSON(status, body);
+};
+const unmarshalNonStandardError = (type, status, body) => {
+  switch (type) {
+    case "unknown_resource":
+      return unknownResourceMapper.UnknownResourceMapper.fromJSON(status, body);
+    case "invalid_request_error":
+      return invalidRequestMapper.InvalidRequestMapper.fromJSON(status, body);
+    default:
+      return null;
+  }
+};
+const parseScalewayError = (status, body) => {
+  const parsableError = typeof body.type === "string" && (unmarshalStandardError(body.type, status, body) ?? unmarshalNonStandardError(body.type, status, body));
+  return parsableError || new scwError.ScalewayError(status, body);
+};
+exports.parseScalewayError = parseScalewayError;

package/dist/scw/errors/error-parser.d.ts

@@ -0,0 +1,12 @@
+import type { JSONObject } from '../../helpers/json';
+import { ScalewayError } from './scw-error';
+/**
+ * Parses Scaleway error from raw body.
+ *
+ * @param status - The status code
+ * @param body - The error response
+ * @returns The resolved error
+ *
+ * @internal
+ */
+export declare const parseScalewayError: (status: number, body: Readonly<JSONObject>) => ScalewayError;

package/dist/scw/errors/error-parser.js

@@ -1,66 +1,55 @@
-import { InvalidRequestMapper } from './non-standard/invalid-request-mapper.js';
-import { UnknownResourceMapper } from './non-standard/unknown-resource-mapper.js';
-import { ScalewayError } from './scw-error.js';
-import { AlreadyExistsError } from './standard/already-exists-error.js';
-import { DeniedAuthenticationError } from './standard/denied-authentication-error.js';
-import { InvalidArgumentsError } from './standard/invalid-arguments-error.js';
-import { OutOfStockError } from './standard/out-of-stock-error.js';
-import { PermissionsDeniedError } from './standard/permissions-denied-error.js';
-import { PreconditionFailedError } from './standard/precondition-failed-error.js';
-import { QuotasExceededError } from './standard/quotas-exceeded-error.js';
-import { ResourceExpiredError } from './standard/resource-expired-error.js';
-import { ResourceLockedError } from './standard/resource-locked-error.js';
-import { ResourceNotFoundError } from './standard/resource-not-found-error.js';
-import { TooManyRequestsError } from './standard/too-many-requests-error.js';
-import { TransientStateError } from './standard/transient-state-error.js';
-
-/**
- * Unmarshals a standard error from raw body.
- *
- * @param type - The error type
- * @param status - The status code
- * @param body - The error response
- * @returns The standard error if found
- *
- * @internal
- */
+import { InvalidRequestMapper } from "./non-standard/invalid-request-mapper.js";
+import { UnknownResourceMapper } from "./non-standard/unknown-resource-mapper.js";
+import { ScalewayError } from "./scw-error.js";
+import { AlreadyExistsError } from "./standard/already-exists-error.js";
+import { DeniedAuthenticationError } from "./standard/denied-authentication-error.js";
+import { InvalidArgumentsError } from "./standard/invalid-arguments-error.js";
+import { OutOfStockError } from "./standard/out-of-stock-error.js";
+import { PermissionsDeniedError } from "./standard/permissions-denied-error.js";
+import { PreconditionFailedError } from "./standard/precondition-failed-error.js";
+import { QuotasExceededError } from "./standard/quotas-exceeded-error.js";
+import { ResourceExpiredError } from "./standard/resource-expired-error.js";
+import { ResourceLockedError } from "./standard/resource-locked-error.js";
+import { ResourceNotFoundError } from "./standard/resource-not-found-error.js";
+import { TooManyRequestsError } from "./standard/too-many-requests-error.js";
+import { TransientStateError } from "./standard/transient-state-error.js";
 const unmarshalStandardError = (type, status, body) => {
   let error;
   switch (type) {
-    case 'denied_authentication':
+    case "denied_authentication":
       error = DeniedAuthenticationError;
       break;
-    case 'invalid_arguments':
+    case "invalid_arguments":
       error = InvalidArgumentsError;
       break;
-    case 'out_of_stock':
+    case "out_of_stock":
       error = OutOfStockError;
       break;
-    case 'permissions_denied':
+    case "permissions_denied":
       error = PermissionsDeniedError;
       break;
-    case 'precondition_failed':
+    case "precondition_failed":
       error = PreconditionFailedError;
       break;
-    case 'quotas_exceeded':
+    case "quotas_exceeded":
       error = QuotasExceededError;
       break;
-    case 'expired':
+    case "expired":
       error = ResourceExpiredError;
       break;
-    case 'not_found':
+    case "not_found":
       error = ResourceNotFoundError;
       break;
-    case 'locked':
+    case "locked":
       error = ResourceLockedError;
       break;
-    case 'transient_state':
+    case "transient_state":
       error = TransientStateError;
       break;
-    case 'already_exists':
+    case "already_exists":
       error = AlreadyExistsError;
       break;
-    case 'too_many_requests':
+    case "too_many_requests":
       error = TooManyRequestsError;
       break;
     default:
@@ -68,40 +57,20 @@ const unmarshalStandardError = (type, status, body) => {
   }
   return error.fromJSON(status, body);
 };
-
-/**
- * Unmarshals a non-standard error from raw body.
- *
- * @param type - The error type
- * @param status - The status code
- * @param body - The error response
- * @returns The non-standard error if found
- *
- * @internal
- */
 const unmarshalNonStandardError = (type, status, body) => {
   switch (type) {
-    case 'unknown_resource':
+    case "unknown_resource":
       return UnknownResourceMapper.fromJSON(status, body);
-    case 'invalid_request_error':
+    case "invalid_request_error":
       return InvalidRequestMapper.fromJSON(status, body);
     default:
       return null;
   }
 };
-
-/**
- * Parses Scaleway error from raw body.
- *
- * @param status - The status code
- * @param body - The error response
- * @returns The resolved error
- *
- * @internal
- */
 const parseScalewayError = (status, body) => {
-  const parsableError = typeof body.type === 'string' && (unmarshalStandardError(body.type, status, body) ?? unmarshalNonStandardError(body.type, status, body));
+  const parsableError = typeof body.type === "string" && (unmarshalStandardError(body.type, status, body) ?? unmarshalNonStandardError(body.type, status, body));
   return parsableError || new ScalewayError(status, body);
 };
-
-export { parseScalewayError };
+export {
+  parseScalewayError
+};

package/dist/scw/errors/non-standard/invalid-request-mapper.cjs

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const scwError = require("../scw-error.cjs");
+const invalidArgumentsError = require("../standard/invalid-arguments-error.cjs");
+const quotasExceededError = require("../standard/quotas-exceeded-error.cjs");
+const types = require("../types.cjs");
+class InvalidRequestMapper {
+  static fromJSON(status, obj) {
+    if (typeof obj.message === "string" && obj.message.toLowerCase().includes("quota exceeded for this resource")) {
+      return new quotasExceededError.QuotasExceededError(status, obj, [
+        {
+          current: 0,
+          quota: 0,
+          resource: typeof obj.resource === "string" ? obj.resource : ""
+        }
+      ]);
+    }
+    const fields = obj.fields && types.isRecordOfStringArray(obj.fields) ? obj.fields : {};
+    const fieldsMessages = Object.entries(fields);
+    if (fieldsMessages.length) {
+      return new invalidArgumentsError.InvalidArgumentsError(
+        status,
+        obj,
+        fieldsMessages.map(
+          ([argumentName, messages]) => messages.map((helpMessage) => ({
+            argumentName,
+            helpMessage,
+            reason: "constraint"
+          }))
+        ).flat()
+      );
+    }
+    return new scwError.ScalewayError(status, obj);
+  }
+}
+exports.InvalidRequestMapper = InvalidRequestMapper;

package/dist/scw/errors/non-standard/invalid-request-mapper.d.ts

@@ -0,0 +1,12 @@
+import type { JSONObject } from '../../../helpers/json';
+import { ScalewayError } from '../scw-error';
+import { InvalidArgumentsError } from '../standard/invalid-arguments-error';
+import { QuotasExceededError } from '../standard/quotas-exceeded-error';
+/**
+ * InvalidRequest error is only returned by the instance API.
+ *
+ * @public
+ */
+export declare class InvalidRequestMapper {
+    static fromJSON(status: number, obj: Readonly<JSONObject>): QuotasExceededError | InvalidArgumentsError | ScalewayError;
+}

package/dist/scw/errors/non-standard/invalid-request-mapper.js

@@ -1,33 +1,36 @@
-import { ScalewayError } from '../scw-error.js';
-import { InvalidArgumentsError } from '../standard/invalid-arguments-error.js';
-import { QuotasExceededError } from '../standard/quotas-exceeded-error.js';
-import { isRecordOfStringArray } from '../types.js';
-
-/**
- * InvalidRequest error is only returned by the instance API.
- *
- * @public
- */
+import { ScalewayError } from "../scw-error.js";
+import { InvalidArgumentsError } from "../standard/invalid-arguments-error.js";
+import { QuotasExceededError } from "../standard/quotas-exceeded-error.js";
+import { isRecordOfStringArray } from "../types.js";
 class InvalidRequestMapper {
   static fromJSON(status, obj) {
-    if (typeof obj.message === 'string' && obj.message.toLowerCase().includes('quota exceeded for this resource')) {
-      return new QuotasExceededError(status, obj, [{
-        current: 0,
-        quota: 0,
-        resource: typeof obj.resource === 'string' ? obj.resource : ''
-      }]);
+    if (typeof obj.message === "string" && obj.message.toLowerCase().includes("quota exceeded for this resource")) {
+      return new QuotasExceededError(status, obj, [
+        {
+          current: 0,
+          quota: 0,
+          resource: typeof obj.resource === "string" ? obj.resource : ""
+        }
+      ]);
     }
     const fields = obj.fields && isRecordOfStringArray(obj.fields) ? obj.fields : {};
     const fieldsMessages = Object.entries(fields);
     if (fieldsMessages.length) {
-      return new InvalidArgumentsError(status, obj, fieldsMessages.map(([argumentName, messages]) => messages.map(helpMessage => ({
-        argumentName,
-        helpMessage,
-        reason: 'constraint'
-      }))).flat());
+      return new InvalidArgumentsError(
+        status,
+        obj,
+        fieldsMessages.map(
+          ([argumentName, messages]) => messages.map((helpMessage) => ({
+            argumentName,
+            helpMessage,
+            reason: "constraint"
+          }))
+        ).flat()
+      );
     }
     return new ScalewayError(status, obj);
   }
 }
-
-export { InvalidRequestMapper };
+export {
+  InvalidRequestMapper
+};

package/dist/scw/errors/non-standard/unknown-resource-mapper.cjs

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const stringValidation = require("../../../internal/validations/string-validation.cjs");
+const scwError = require("../scw-error.cjs");
+const resourceNotFoundError = require("../standard/resource-not-found-error.cjs");
+class UnknownResourceMapper {
+  static fromJSON(status, obj) {
+    const messageParts = typeof obj.message === "string" ? obj.message.split(/"|'/) : [];
+    if (messageParts.length === 3 && stringValidation.isUUID(messageParts[1])) {
+      return new resourceNotFoundError.ResourceNotFoundError(
+        status,
+        obj,
+        // transform `Security group ` to `security_group`
+        // `.replaceAll()` may be too recent to use yet.
+        // that's why we're using `.split(' ').join('_')` for now.
+        messageParts[0].trim().toLowerCase().split(" ").join("_"),
+        messageParts[1]
+      );
+    }
+    return new scwError.ScalewayError(status, obj);
+  }
+}
+exports.UnknownResourceMapper = UnknownResourceMapper;

package/dist/scw/errors/non-standard/unknown-resource-mapper.d.ts

@@ -0,0 +1,11 @@
+import type { JSONObject } from '../../../helpers/json';
+import { ScalewayError } from '../scw-error';
+import { ResourceNotFoundError } from '../standard/resource-not-found-error';
+/**
+ * UnknownResource error is only returned by the instance API.
+ *
+ * @public
+ */
+export declare class UnknownResourceMapper {
+    static fromJSON(status: number, obj: Readonly<JSONObject>): ResourceNotFoundError | ScalewayError;
+}

package/dist/scw/errors/non-standard/unknown-resource-mapper.js

@@ -1,27 +1,23 @@
-import { isUUID } from '../../../internal/validations/string-validation.js';
-import { ScalewayError } from '../scw-error.js';
-import { ResourceNotFoundError } from '../standard/resource-not-found-error.js';
-
-/**
- * UnknownResource error is only returned by the instance API.
- *
- * @public
- */
+import { isUUID } from "../../../internal/validations/string-validation.js";
+import { ScalewayError } from "../scw-error.js";
+import { ResourceNotFoundError } from "../standard/resource-not-found-error.js";
 class UnknownResourceMapper {
   static fromJSON(status, obj) {
-    // Split the message
-    // Note: some errors uses ' and not "
-    // Examples: `"111..." not found` or `Security Group '111...' not found`
-    const messageParts = typeof obj.message === 'string' ? obj.message.split(/"|'/) : [];
+    const messageParts = typeof obj.message === "string" ? obj.message.split(/"|'/) : [];
     if (messageParts.length === 3 && isUUID(messageParts[1])) {
-      return new ResourceNotFoundError(status, obj,
-      // transform `Security group ` to `security_group`
-      // `.replaceAll()` may be too recent to use yet.
-      // that's why we're using `.split(' ').join('_')` for now.
-      messageParts[0].trim().toLowerCase().split(' ').join('_'), messageParts[1]);
+      return new ResourceNotFoundError(
+        status,
+        obj,
+        // transform `Security group ` to `security_group`
+        // `.replaceAll()` may be too recent to use yet.
+        // that's why we're using `.split(' ').join('_')` for now.
+        messageParts[0].trim().toLowerCase().split(" ").join("_"),
+        messageParts[1]
+      );
     }
     return new ScalewayError(status, obj);
   }
 }
-
-export { UnknownResourceMapper };
+export {
+  UnknownResourceMapper
+};

package/dist/scw/errors/scw-error-from-json.d.ts

@@ -0,0 +1,10 @@
+import type { JSONObject } from '../../helpers/json';
+import type { ScalewayError } from './scw-error';
+/**
+ * Interface with static method that initialize {@link ScalewayError} from JSON.
+ *
+ * @internal
+ */
+export interface ScalewayErrorFromJSONInitializer {
+    fromJSON(status: number, obj: Readonly<JSONObject>): ScalewayError | null;
+}