@scaleway/sdk-client 2.1.0 → 2.2.0

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

@@ -1,21 +1,14 @@
 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
+*/
 const mapUnknownResourceFromJSON = (status, obj) => {
-  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 ScalewayError(status, obj);
-};
-export {
-  mapUnknownResourceFromJSON
+	const messageParts = typeof obj.message === "string" ? obj.message.split(/"|'/) : [];
+	if (messageParts.length === 3 && isUUID(messageParts[1])) return new ResourceNotFoundError(status, obj, messageParts[0].trim().toLowerCase().split(" ").join("_"), messageParts[1]);
+	return new ScalewayError(status, obj);
 };
+export { mapUnknownResourceFromJSON };

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

@@ -1,43 +1,46 @@
 import { isJSONObject } from "../../helpers/json.js";
 import { isRecordOfStringArray } from "./types.js";
-const buildDefaultMessage = (status, body) => {
-  const message = [`http error ${status}`];
-  if (typeof body === "string") {
-    message.push(body);
-  } else if (isJSONObject(body)) {
-    if (typeof body.resource === "string") {
-      message.push(`resource ${body.resource}`);
-    }
-    if (typeof body.message === "string") {
-      message.push(body.message);
-    }
-    if (body.fields && isRecordOfStringArray(body.fields)) {
-      message.push(
-        Object.entries(body.fields).map(([name, list]) => `${name} (${list.join(", ")})`).join(", ")
-      );
-    }
-  }
-  return message.join(": ");
+/**
+* Builds the default message for {@link ScalewayError}.
+*
+* @param status - The response code
+* @param body - The response body
+* @returns The error message
+*
+* @internal
+*/
+var buildDefaultMessage = (status, body) => {
+	const message = [`http error ${status}`];
+	if (typeof body === "string") message.push(body);
+	else if (isJSONObject(body)) {
+		if (typeof body.resource === "string") message.push(`resource ${body.resource}`);
+		if (typeof body.message === "string") message.push(body.message);
+		if (body.fields && isRecordOfStringArray(body.fields)) message.push(Object.entries(body.fields).map(([name, list]) => `${name} (${list.join(", ")})`).join(", "));
+	}
+	return message.join(": ");
 };
-class ScalewayError extends Error {
-  constructor(status, body, message = buildDefaultMessage(status, body)) {
-    super(message);
-    this.status = status;
-    this.body = body;
-    this.message = message;
-    this.name = "ScalewayError";
-    this.rawMessage = typeof body === "object" && typeof body.message === "string" ? body.message : void 0;
-    Object.setPrototypeOf(this, new.target.prototype);
-  }
-  /** The message originating from the payload. */
-  rawMessage;
-  static fromJSON(status, obj) {
-    return new ScalewayError(status, obj);
-  }
-  toString() {
-    return `${this.name}: ${this.message}`;
-  }
-}
-export {
-  ScalewayError
+/**
+* Scaleway error.
+*
+* @public
+*/
+var ScalewayError = class ScalewayError extends Error {
+	/** The message originating from the payload. */
+	rawMessage;
+	constructor(status, body, message = buildDefaultMessage(status, body)) {
+		super(message);
+		this.status = status;
+		this.body = body;
+		this.message = message;
+		this.name = "ScalewayError";
+		this.rawMessage = typeof body === "object" && typeof body.message === "string" ? body.message : void 0;
+		Object.setPrototypeOf(this, new.target.prototype);
+	}
+	static fromJSON(status, obj) {
+		return new ScalewayError(status, obj);
+	}
+	toString() {
+		return `${this.name}: ${this.message}`;
+	}
 };
+export { ScalewayError };

package/dist/scw/errors/standard/already-exists-error.js

@@ -1,31 +1,22 @@
 import { ScalewayError } from "../scw-error.js";
-class AlreadyExistsError extends ScalewayError {
-  constructor(status, body, resource, resourceId, helpMessage) {
-    super(
-      status,
-      body,
-      `resource ${resource} with ID ${resourceId} already exists: ${helpMessage}`
-    );
-    this.status = status;
-    this.body = body;
-    this.resource = resource;
-    this.resourceId = resourceId;
-    this.helpMessage = helpMessage;
-    this.name = "AlreadyExistsError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string" || typeof obj.help_message !== "string") {
-      return null;
-    }
-    return new AlreadyExistsError(
-      status,
-      obj,
-      obj.resource,
-      obj.resource_id,
-      obj.help_message
-    );
-  }
-}
-export {
-  AlreadyExistsError
+/**
+* AlreadyExists error is used when a resource already exists.
+*
+* @public
+*/
+var AlreadyExistsError = class AlreadyExistsError extends ScalewayError {
+	constructor(status, body, resource, resourceId, helpMessage) {
+		super(status, body, `resource ${resource} with ID ${resourceId} already exists: ${helpMessage}`);
+		this.status = status;
+		this.body = body;
+		this.resource = resource;
+		this.resourceId = resourceId;
+		this.helpMessage = helpMessage;
+		this.name = "AlreadyExistsError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string" || typeof obj.help_message !== "string") return null;
+		return new AlreadyExistsError(status, obj, obj.resource, obj.resource_id, obj.help_message);
+	}
 };
+export { AlreadyExistsError };

package/dist/scw/errors/standard/denied-authentication-error.js

@@ -1,37 +1,46 @@
 import { ScalewayError } from "../scw-error.js";
-const buildMessage = (method, reason) => {
-  let reasonDesc;
-  switch (reason) {
-    case "invalid_argument":
-      reasonDesc = `invalid ${method} format or empty value`;
-      break;
-    case "not_found":
-      reasonDesc = `${method} does not exist`;
-      break;
-    case "expired":
-      reasonDesc = `${method} is expired`;
-      break;
-    default:
-      reasonDesc = `unknown reason for ${method}`;
-  }
-  return `denied authentication: ${reasonDesc}`;
+/**
+* Build the default message for {@link DeniedAuthenticationError}.
+*
+* @param method - The authentication method
+* @param reason - The deny reason
+* @returns The error message
+*
+* @internal
+*/
+var buildMessage = (method, reason) => {
+	let reasonDesc;
+	switch (reason) {
+		case "invalid_argument":
+			reasonDesc = `invalid ${method} format or empty value`;
+			break;
+		case "not_found":
+			reasonDesc = `${method} does not exist`;
+			break;
+		case "expired":
+			reasonDesc = `${method} is expired`;
+			break;
+		default: reasonDesc = `unknown reason for ${method}`;
+	}
+	return `denied authentication: ${reasonDesc}`;
 };
-class DeniedAuthenticationError extends ScalewayError {
-  constructor(status, body, method, reason) {
-    super(status, body, buildMessage(method, reason));
-    this.status = status;
-    this.body = body;
-    this.method = method;
-    this.reason = reason;
-    this.name = "DeniedAuthenticationError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.method !== "string" || typeof obj.reason !== "string") {
-      return null;
-    }
-    return new DeniedAuthenticationError(status, obj, obj.method, obj.reason);
-  }
-}
-export {
-  DeniedAuthenticationError
+/**
+* DeniedAuthentication error is used by the API Gateway auth service to deny a request.
+*
+* @public
+*/
+var DeniedAuthenticationError = class DeniedAuthenticationError extends ScalewayError {
+	constructor(status, body, method, reason) {
+		super(status, body, buildMessage(method, reason));
+		this.status = status;
+		this.body = body;
+		this.method = method;
+		this.reason = reason;
+		this.name = "DeniedAuthenticationError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.method !== "string" || typeof obj.reason !== "string") return null;
+		return new DeniedAuthenticationError(status, obj, obj.method, obj.reason);
+	}
 };
+export { DeniedAuthenticationError };

package/dist/scw/errors/standard/index.js

@@ -1,28 +1,30 @@
+import { __exportAll } from "../../../_virtual/_rolldown/runtime.js";
 import { ScalewayError } from "../scw-error.js";
+import { InvalidArgumentsError } from "./invalid-arguments-error.js";
+import { QuotasExceededError } from "./quotas-exceeded-error.js";
+import { ResourceNotFoundError } from "./resource-not-found-error.js";
 import { AlreadyExistsError } from "./already-exists-error.js";
 import { DeniedAuthenticationError } from "./denied-authentication-error.js";
-import { InvalidArgumentsError } from "./invalid-arguments-error.js";
 import { OutOfStockError } from "./out-of-stock-error.js";
 import { PermissionsDeniedError } from "./permissions-denied-error.js";
 import { PreconditionFailedError } from "./precondition-failed-error.js";
-import { QuotasExceededError } from "./quotas-exceeded-error.js";
 import { ResourceExpiredError } from "./resource-expired-error.js";
 import { ResourceLockedError } from "./resource-locked-error.js";
-import { ResourceNotFoundError } from "./resource-not-found-error.js";
 import { TooManyRequestsError } from "./too-many-requests-error.js";
 import { TransientStateError } from "./transient-state-error.js";
-export {
-  AlreadyExistsError,
-  DeniedAuthenticationError,
-  InvalidArgumentsError,
-  OutOfStockError,
-  PermissionsDeniedError,
-  PreconditionFailedError,
-  QuotasExceededError,
-  ResourceExpiredError,
-  ResourceLockedError,
-  ResourceNotFoundError,
-  ScalewayError,
-  TooManyRequestsError,
-  TransientStateError
-};
+var standard_exports = /* @__PURE__ */ __exportAll({
+	AlreadyExistsError: () => AlreadyExistsError,
+	DeniedAuthenticationError: () => DeniedAuthenticationError,
+	InvalidArgumentsError: () => InvalidArgumentsError,
+	OutOfStockError: () => OutOfStockError,
+	PermissionsDeniedError: () => PermissionsDeniedError,
+	PreconditionFailedError: () => PreconditionFailedError,
+	QuotasExceededError: () => QuotasExceededError,
+	ResourceExpiredError: () => ResourceExpiredError,
+	ResourceLockedError: () => ResourceLockedError,
+	ResourceNotFoundError: () => ResourceNotFoundError,
+	ScalewayError: () => ScalewayError,
+	TooManyRequestsError: () => TooManyRequestsError,
+	TransientStateError: () => TransientStateError
+});
+export { standard_exports };

package/dist/scw/errors/standard/invalid-arguments-error.js

@@ -1,54 +1,55 @@
 import { isJSONObject } from "../../../helpers/json.js";
 import { ScalewayError } from "../scw-error.js";
-const buildMessage = (list) => {
-  const invalidArgs = list.reduce((acc, details) => {
-    let readableReason = "";
-    switch (details.reason) {
-      case "required":
-        readableReason = `is required`;
-        break;
-      case "format":
-        readableReason = `is wrongly formatted`;
-        break;
-      case "constraint":
-        readableReason = `does not respect constraint`;
-        break;
-      default:
-        readableReason = `is invalid for unexpected reason`;
-        break;
-    }
-    if (details.helpMessage && details.helpMessage.length > 0) {
-      readableReason = readableReason.concat(`, `, details.helpMessage);
-    }
-    acc.push(`${details.argumentName} ${readableReason}`);
-    return acc;
-  }, []);
-  return `invalid argument(s): ${invalidArgs.join("; ")}`;
+/**
+* Build the default message for {@link InvalidArgumentsError}.
+*
+* @param list - The list of {@link InvalidArgumentsErrorDetails}
+* @returns The error message
+*
+* @internal
+*/
+var buildMessage = (list) => {
+	return `invalid argument(s): ${list.reduce((acc, details) => {
+		let readableReason = "";
+		switch (details.reason) {
+			case "required":
+				readableReason = `is required`;
+				break;
+			case "format":
+				readableReason = `is wrongly formatted`;
+				break;
+			case "constraint":
+				readableReason = `does not respect constraint`;
+				break;
+			default:
+				readableReason = `is invalid for unexpected reason`;
+				break;
+		}
+		if (details.helpMessage && details.helpMessage.length > 0) readableReason = readableReason.concat(`, `, details.helpMessage);
+		acc.push(`${details.argumentName} ${readableReason}`);
+		return acc;
+	}, []).join("; ")}`;
 };
-class InvalidArgumentsError extends ScalewayError {
-  constructor(status, body, details) {
-    super(status, body, buildMessage(details));
-    this.status = status;
-    this.body = body;
-    this.details = details;
-    this.name = "InvalidArgumentsError";
-  }
-  static fromJSON(status, obj) {
-    if (!Array.isArray(obj.details)) return null;
-    return new InvalidArgumentsError(
-      status,
-      obj,
-      obj.details.reduce(
-        (list, detail) => isJSONObject(detail) && typeof detail.argument_name === "string" && typeof detail.reason === "string" ? list.concat({
-          argumentName: detail.argument_name,
-          helpMessage: typeof detail.help_message === "string" ? detail.help_message : void 0,
-          reason: detail.reason
-        }) : list,
-        []
-      )
-    );
-  }
-}
-export {
-  InvalidArgumentsError
+/**
+* InvalidArguments error happens when one or many fields are invalid in the request message.
+*
+* @public
+*/
+var InvalidArgumentsError = class InvalidArgumentsError extends ScalewayError {
+	constructor(status, body, details) {
+		super(status, body, buildMessage(details));
+		this.status = status;
+		this.body = body;
+		this.details = details;
+		this.name = "InvalidArgumentsError";
+	}
+	static fromJSON(status, obj) {
+		if (!Array.isArray(obj.details)) return null;
+		return new InvalidArgumentsError(status, obj, obj.details.reduce((list, detail) => isJSONObject(detail) && typeof detail.argument_name === "string" && typeof detail.reason === "string" ? list.concat({
+			argumentName: detail.argument_name,
+			helpMessage: typeof detail.help_message === "string" ? detail.help_message : void 0,
+			reason: detail.reason
+		}) : list, []));
+	}
 };
+export { InvalidArgumentsError };

package/dist/scw/errors/standard/out-of-stock-error.js

@@ -1,17 +1,20 @@
 import { ScalewayError } from "../scw-error.js";
-class OutOfStockError extends ScalewayError {
-  constructor(status, body, resource) {
-    super(status, body, `resource ${resource} is out of stock`);
-    this.status = status;
-    this.body = body;
-    this.resource = resource;
-    this.name = "OutOfStockError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.resource !== "string") return null;
-    return new OutOfStockError(status, obj, obj.resource);
-  }
-}
-export {
-  OutOfStockError
+/**
+* OutOfStock error happens when stocks are empty for the resource.
+*
+* @public
+*/
+var OutOfStockError = class OutOfStockError extends ScalewayError {
+	constructor(status, body, resource) {
+		super(status, body, `resource ${resource} is out of stock`);
+		this.status = status;
+		this.body = body;
+		this.resource = resource;
+		this.name = "OutOfStockError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.resource !== "string") return null;
+		return new OutOfStockError(status, obj, obj.resource);
+	}
 };
+export { OutOfStockError };

package/dist/scw/errors/standard/permissions-denied-error.js

@@ -1,29 +1,33 @@
 import { isJSONObject } from "../../../helpers/json.js";
 import { ScalewayError } from "../scw-error.js";
-const buildMessage = (list) => `insufficient permissions: ${list.map(({ action, resource }) => `${action} ${resource}`).join("; ")}`;
-class PermissionsDeniedError extends ScalewayError {
-  constructor(status, body, list) {
-    super(status, body, buildMessage(list));
-    this.status = status;
-    this.body = body;
-    this.list = list;
-    this.name = "PermissionsDeniedError";
-  }
-  static fromJSON(status, obj) {
-    if (!Array.isArray(obj.details)) return null;
-    return new PermissionsDeniedError(
-      status,
-      obj,
-      obj.details.reduce(
-        (list, detail) => isJSONObject(detail) && typeof detail.resource === "string" && typeof detail.action === "string" ? list.concat({
-          action: detail.action,
-          resource: detail.resource
-        }) : list,
-        []
-      )
-    );
-  }
-}
-export {
-  PermissionsDeniedError
+/**
+* Build the default message for {@link PermissionsDeniedError}.
+*
+* @param list - The list of {@link PermissionsDeniedErrorDetails}
+* @returns The error message
+*
+* @internal
+*/
+var buildMessage = (list) => `insufficient permissions: ${list.map(({ action, resource }) => `${action} ${resource}`).join("; ")}`;
+/**
+* PermissionsDenied error happens when one or many permissions are not accorded to the user making the request.
+*
+* @public
+*/
+var PermissionsDeniedError = class PermissionsDeniedError extends ScalewayError {
+	constructor(status, body, list) {
+		super(status, body, buildMessage(list));
+		this.status = status;
+		this.body = body;
+		this.list = list;
+		this.name = "PermissionsDeniedError";
+	}
+	static fromJSON(status, obj) {
+		if (!Array.isArray(obj.details)) return null;
+		return new PermissionsDeniedError(status, obj, obj.details.reduce((list, detail) => isJSONObject(detail) && typeof detail.resource === "string" && typeof detail.action === "string" ? list.concat({
+			action: detail.action,
+			resource: detail.resource
+		}) : list, []));
+	}
 };
+export { PermissionsDeniedError };

package/dist/scw/errors/standard/precondition-failed-error.js

@@ -1,32 +1,35 @@
 import { ScalewayError } from "../scw-error.js";
-const buildMessage = (precondition, helpMessage) => {
-  let message = `precondition failed: ${precondition}`;
-  if (typeof helpMessage === "string" && helpMessage.length > 0) {
-    message = message.concat(", ", helpMessage);
-  }
-  return message;
+/**
+* Build the default message for {@link PreconditionFailedError}.
+*
+* @param precondition - The precondition
+* @param helpMessage - The message which should help the user to fix the root cause
+* @returns The error message
+*
+* @internal
+*/
+var buildMessage = (precondition, helpMessage) => {
+	let message = `precondition failed: ${precondition}`;
+	if (typeof helpMessage === "string" && helpMessage.length > 0) message = message.concat(", ", helpMessage);
+	return message;
 };
-class PreconditionFailedError extends ScalewayError {
-  constructor(status, body, precondition, helpMessage) {
-    super(status, body, buildMessage(precondition, helpMessage));
-    this.status = status;
-    this.body = body;
-    this.precondition = precondition;
-    this.helpMessage = helpMessage;
-    this.name = "PreconditionFailedError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.precondition !== "string" || typeof obj.help_message !== "string") {
-      return null;
-    }
-    return new PreconditionFailedError(
-      status,
-      obj,
-      obj.precondition,
-      obj.help_message
-    );
-  }
-}
-export {
-  PreconditionFailedError
+/**
+* PreconditionFailed error is used when a precondition is not respected.
+*
+* @public
+*/
+var PreconditionFailedError = class PreconditionFailedError extends ScalewayError {
+	constructor(status, body, precondition, helpMessage) {
+		super(status, body, buildMessage(precondition, helpMessage));
+		this.status = status;
+		this.body = body;
+		this.precondition = precondition;
+		this.helpMessage = helpMessage;
+		this.name = "PreconditionFailedError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.precondition !== "string" || typeof obj.help_message !== "string") return null;
+		return new PreconditionFailedError(status, obj, obj.precondition, obj.help_message);
+	}
 };
+export { PreconditionFailedError };