@scaleway/sdk-client 2.1.0 → 2.2.0

package/dist/scw/errors/standard/quotas-exceeded-error.js

@@ -1,43 +1,48 @@
 import { isJSONObject } from "../../../helpers/json.js";
 import { ScalewayError } from "../scw-error.js";
-const buildMessage = (list) => `quota(s) exceeded: ${list.map((details) => {
-  const message = `Quotas reached: You have reached the maximum number of ${details.resource} authorized by your Organization. Access the quotas page from your Organization dashboard to manage quotas.`;
-  return details.scope ? `${message} for ${details.scope.kind} '${details.scope.id}'` : message;
+/**
+* Build the default message for {@link QuotasExceededError}.
+*
+* @param list - The list of {@link QuotasExceededErrorDetails}
+* @returns The error message
+*
+* @internal
+*/
+var buildMessage = (list) => `quota(s) exceeded: ${list.map((details) => {
+	const message = `Quotas reached: You have reached the maximum number of ${details.resource} authorized by your Organization. Access the quotas page from your Organization dashboard to manage quotas.`;
+	return details.scope ? `${message} for ${details.scope.kind} '${details.scope.id}'` : message;
 }).join("; ")}`;
-const buildScope = (detail) => {
-  if (typeof detail.organization_id === "string" && detail.organization_id.length) {
-    return { id: detail.organization_id, kind: "organization" };
-  }
-  if (typeof detail.project_id === "string" && detail.project_id.length) {
-    return { id: detail.project_id, kind: "project" };
-  }
-  return void 0;
+var buildScope = (detail) => {
+	if (typeof detail.organization_id === "string" && detail.organization_id.length) return {
+		id: detail.organization_id,
+		kind: "organization"
+	};
+	if (typeof detail.project_id === "string" && detail.project_id.length) return {
+		id: detail.project_id,
+		kind: "project"
+	};
 };
-class QuotasExceededError extends ScalewayError {
-  constructor(status, body, list) {
-    super(status, body, buildMessage(list));
-    this.status = status;
-    this.body = body;
-    this.list = list;
-    this.name = "QuotasExceededError";
-  }
-  static fromJSON(status, obj) {
-    if (!Array.isArray(obj.details)) return null;
-    return new QuotasExceededError(
-      status,
-      obj,
-      obj.details.reduce(
-        (list, detail) => isJSONObject(detail) && typeof detail.resource === "string" && typeof detail.quota === "number" && typeof detail.current === "number" ? list.concat({
-          current: detail.current,
-          quota: detail.quota,
-          resource: detail.resource,
-          scope: buildScope(detail)
-        }) : list,
-        []
-      )
-    );
-  }
-}
-export {
-  QuotasExceededError
+/**
+* QuotasExceeded error happens when one or many resource exceed quotas during the creation of a resource.
+*
+* @public
+*/
+var QuotasExceededError = class QuotasExceededError extends ScalewayError {
+	constructor(status, body, list) {
+		super(status, body, buildMessage(list));
+		this.status = status;
+		this.body = body;
+		this.list = list;
+		this.name = "QuotasExceededError";
+	}
+	static fromJSON(status, obj) {
+		if (!Array.isArray(obj.details)) return null;
+		return new QuotasExceededError(status, obj, obj.details.reduce((list, detail) => isJSONObject(detail) && typeof detail.resource === "string" && typeof detail.quota === "number" && typeof detail.current === "number" ? list.concat({
+			current: detail.current,
+			quota: detail.quota,
+			resource: detail.resource,
+			scope: buildScope(detail)
+		}) : list, []));
+	}
 };
+export { QuotasExceededError };

package/dist/scw/errors/standard/resource-expired-error.js

@@ -1,31 +1,22 @@
 import { ScalewayError } from "../scw-error.js";
-class ResourceExpiredError extends ScalewayError {
-  constructor(status, body, resource, resourceId, expiredSince) {
-    super(
-      status,
-      body,
-      `resource ${resource} with ID ${resourceId} expired since ${expiredSince.toISOString()}`
-    );
-    this.status = status;
-    this.body = body;
-    this.resource = resource;
-    this.resourceId = resourceId;
-    this.expiredSince = expiredSince;
-    this.name = "ResourceExpiredError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string" || typeof obj.expired_since !== "string") {
-      return null;
-    }
-    return new ResourceExpiredError(
-      status,
-      obj,
-      obj.resource,
-      obj.resource_id,
-      new Date(obj.expired_since)
-    );
-  }
-}
-export {
-  ResourceExpiredError
+/**
+* ResourceExpired error happens when trying to access a resource that has expired.
+*
+* @public
+*/
+var ResourceExpiredError = class ResourceExpiredError extends ScalewayError {
+	constructor(status, body, resource, resourceId, expiredSince) {
+		super(status, body, `resource ${resource} with ID ${resourceId} expired since ${expiredSince.toISOString()}`);
+		this.status = status;
+		this.body = body;
+		this.resource = resource;
+		this.resourceId = resourceId;
+		this.expiredSince = expiredSince;
+		this.name = "ResourceExpiredError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string" || typeof obj.expired_since !== "string") return null;
+		return new ResourceExpiredError(status, obj, obj.resource, obj.resource_id, new Date(obj.expired_since));
+	}
 };
+export { ResourceExpiredError };

package/dist/scw/errors/standard/resource-locked-error.js

@@ -1,20 +1,21 @@
 import { ScalewayError } from "../scw-error.js";
-class ResourceLockedError extends ScalewayError {
-  constructor(status, body, resource, resourceId) {
-    super(status, body, `resource ${resource} with ID ${resourceId} is locked`);
-    this.status = status;
-    this.body = body;
-    this.resource = resource;
-    this.resourceId = resourceId;
-    this.name = "ResourceLockedError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string") {
-      return null;
-    }
-    return new ResourceLockedError(status, obj, obj.resource, obj.resource_id);
-  }
-}
-export {
-  ResourceLockedError
+/**
+* ResourceLocked error happens when a resource is locked by trust and safety.
+*
+* @public
+*/
+var ResourceLockedError = class ResourceLockedError extends ScalewayError {
+	constructor(status, body, resource, resourceId) {
+		super(status, body, `resource ${resource} with ID ${resourceId} is locked`);
+		this.status = status;
+		this.body = body;
+		this.resource = resource;
+		this.resourceId = resourceId;
+		this.name = "ResourceLockedError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string") return null;
+		return new ResourceLockedError(status, obj, obj.resource, obj.resource_id);
+	}
 };
+export { ResourceLockedError };

package/dist/scw/errors/standard/resource-not-found-error.js

@@ -1,24 +1,21 @@
 import { ScalewayError } from "../scw-error.js";
-class ResourceNotFoundError extends ScalewayError {
-  constructor(status, body, resource, resourceId) {
-    super(
-      status,
-      body,
-      `resource ${resource} with ID ${resourceId} is not found`
-    );
-    this.status = status;
-    this.body = body;
-    this.resource = resource;
-    this.resourceId = resourceId;
-    this.name = "ResourceNotFoundError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string") {
-      return null;
-    }
-    return new ResourceNotFoundError(status, obj, obj.resource, obj.resource_id);
-  }
-}
-export {
-  ResourceNotFoundError
+/**
+* ResourceNotFound error happens when getting a resource that does not exist anymore.
+*
+* @public
+*/
+var ResourceNotFoundError = class ResourceNotFoundError extends ScalewayError {
+	constructor(status, body, resource, resourceId) {
+		super(status, body, `resource ${resource} with ID ${resourceId} is not found`);
+		this.status = status;
+		this.body = body;
+		this.resource = resource;
+		this.resourceId = resourceId;
+		this.name = "ResourceNotFoundError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string") return null;
+		return new ResourceNotFoundError(status, obj, obj.resource, obj.resource_id);
+	}
 };
+export { ResourceNotFoundError };

package/dist/scw/errors/standard/too-many-requests-error.js

@@ -1,58 +1,45 @@
 import { isJSONObject } from "../../../helpers/json.js";
 import { ScalewayError } from "../scw-error.js";
-const buildMessage = (helpMessage, limit, resetSeconds, resetAt) => {
-  const details = [];
-  if (limit) {
-    if (limit.windowSeconds) {
-      details.push(`quota is ${limit.quota} for ${limit.windowSeconds}s`);
-    } else {
-      details.push(`quota is ${limit.quota}`);
-    }
-  }
-  if (resetSeconds) {
-    details.push(`resets in ${resetSeconds}s`);
-  } else if (resetAt) {
-    details.push(`resets at ${resetAt.toISOString()}`);
-  }
-  let output = `too many requests`;
-  if (details.length > 0) {
-    output += ` (${details.join(", ")})`;
-  }
-  if (helpMessage.length > 0) {
-    output += `: ${helpMessage}`;
-  }
-  return output;
+/**
+* Build the default message for {@link TooManyRequestsError}.
+*
+* @internal
+*/
+var buildMessage = (helpMessage, limit, resetSeconds, resetAt) => {
+	const details = [];
+	if (limit) if (limit.windowSeconds) details.push(`quota is ${limit.quota} for ${limit.windowSeconds}s`);
+	else details.push(`quota is ${limit.quota}`);
+	if (resetSeconds) details.push(`resets in ${resetSeconds}s`);
+	else if (resetAt) details.push(`resets at ${resetAt.toISOString()}`);
+	let output = `too many requests`;
+	if (details.length > 0) output += ` (${details.join(", ")})`;
+	if (helpMessage.length > 0) output += `: ${helpMessage}`;
+	return output;
 };
-class TooManyRequestsError extends ScalewayError {
-  constructor(status, body, helpMessage, limit, resetSeconds, resetAt) {
-    super(status, body, buildMessage(helpMessage, limit, resetSeconds, resetAt));
-    this.status = status;
-    this.body = body;
-    this.helpMessage = helpMessage;
-    this.limit = limit;
-    this.resetSeconds = resetSeconds;
-    this.resetAt = resetAt;
-    this.name = "TooManyRequestsError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.help_message !== "string") return null;
-    let limit;
-    if (isJSONObject(obj.limit) && typeof obj.limit.quota === "number") {
-      limit = {
-        quota: obj.limit.quota,
-        windowSeconds: typeof obj.limit.window_seconds === "number" ? obj.limit.window_seconds : void 0
-      };
-    }
-    return new TooManyRequestsError(
-      status,
-      obj,
-      obj.help_message,
-      limit,
-      typeof obj.reset_seconds === "number" ? obj.reset_seconds : void 0,
-      typeof obj.reset_at === "string" ? new Date(obj.reset_at) : void 0
-    );
-  }
-}
-export {
-  TooManyRequestsError
+/**
+* TooManyRequestsError error happens when fetching too many times a resource.
+*
+* @public
+*/
+var TooManyRequestsError = class TooManyRequestsError extends ScalewayError {
+	constructor(status, body, helpMessage, limit, resetSeconds, resetAt) {
+		super(status, body, buildMessage(helpMessage, limit, resetSeconds, resetAt));
+		this.status = status;
+		this.body = body;
+		this.helpMessage = helpMessage;
+		this.limit = limit;
+		this.resetSeconds = resetSeconds;
+		this.resetAt = resetAt;
+		this.name = "TooManyRequestsError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.help_message !== "string") return null;
+		let limit;
+		if (isJSONObject(obj.limit) && typeof obj.limit.quota === "number") limit = {
+			quota: obj.limit.quota,
+			windowSeconds: typeof obj.limit.window_seconds === "number" ? obj.limit.window_seconds : void 0
+		};
+		return new TooManyRequestsError(status, obj, obj.help_message, limit, typeof obj.reset_seconds === "number" ? obj.reset_seconds : void 0, typeof obj.reset_at === "string" ? new Date(obj.reset_at) : void 0);
+	}
 };
+export { TooManyRequestsError };

package/dist/scw/errors/standard/transient-state-error.js

@@ -1,31 +1,22 @@
 import { ScalewayError } from "../scw-error.js";
-class TransientStateError extends ScalewayError {
-  constructor(status, body, resource, resourceId, currentState) {
-    super(
-      status,
-      body,
-      `resource ${resource} with ID ${resourceId} is in a transient state: ${currentState}`
-    );
-    this.status = status;
-    this.body = body;
-    this.resource = resource;
-    this.resourceId = resourceId;
-    this.currentState = currentState;
-    this.name = "TransientStateError";
-  }
-  static fromJSON(status, obj) {
-    if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string" || typeof obj.current_state !== "string") {
-      return null;
-    }
-    return new TransientStateError(
-      status,
-      obj,
-      obj.resource,
-      obj.resource_id,
-      obj.current_state
-    );
-  }
-}
-export {
-  TransientStateError
+/**
+* TransientState error happens when trying to perform an action on a resource in a transient state.
+*
+* @public
+*/
+var TransientStateError = class TransientStateError extends ScalewayError {
+	constructor(status, body, resource, resourceId, currentState) {
+		super(status, body, `resource ${resource} with ID ${resourceId} is in a transient state: ${currentState}`);
+		this.status = status;
+		this.body = body;
+		this.resource = resource;
+		this.resourceId = resourceId;
+		this.currentState = currentState;
+		this.name = "TransientStateError";
+	}
+	static fromJSON(status, obj) {
+		if (typeof obj.resource !== "string" || typeof obj.resource_id !== "string" || typeof obj.current_state !== "string") return null;
+		return new TransientStateError(status, obj, obj.resource, obj.resource_id, obj.current_state);
+	}
 };
+export { TransientStateError };

package/dist/scw/errors/types.js

@@ -1,15 +1,15 @@
 import { isJSONObject } from "../../helpers/json.js";
+/**
+* Verifies the object is a record of string to string[].
+*
+* @param obj - The object
+* @returns Whether the object is of the expected type
+*
+* @internal
+*/
 const isRecordOfStringArray = (obj) => {
-  if (!isJSONObject(obj)) {
-    return false;
-  }
-  for (const elt of Object.values(obj)) {
-    if (!Array.isArray(elt) || Object.values(elt).find((x) => typeof x !== "string") !== void 0) {
-      return false;
-    }
-  }
-  return true;
-};
-export {
-  isRecordOfStringArray
+	if (!isJSONObject(obj)) return false;
+	for (const elt of Object.values(obj)) if (!Array.isArray(elt) || Object.values(elt).find((x) => typeof x !== "string") !== void 0) return false;
+	return true;
 };
+export { isRecordOfStringArray };

package/dist/scw/fetch/build-fetcher.js

@@ -1,61 +1,56 @@
-import { isBrowser } from "../../helpers/is-browser.js";
-import { composeRequestInterceptors, composeResponseInterceptors, composeResponseErrorInterceptors } from "../../internal/interceptors/composer.js";
 import { obfuscateAuthHeadersEntry } from "../auth.js";
+import { isBrowser } from "../../helpers/is-browser.js";
+import { composeRequestInterceptors, composeResponseErrorInterceptors, composeResponseInterceptors } from "../../internal/interceptors/composer.js";
 import { logRequest, logResponse, obfuscateInterceptor } from "./http-interceptors.js";
 import { responseParser } from "./response-parser.js";
+/**
+* Builds Request from {@link ScwRequest} & {@link Settings}.
+*
+* @param request - A scaleway request
+* @param settings - The settings
+* @returns A fetch Request
+*
+* @internal
+*/
 const buildRequest = (request, settings) => {
-  let { path } = request;
-  if (request.urlParams instanceof URLSearchParams) {
-    path = path.concat(`?${request.urlParams.toString()}`);
-  }
-  return new Request(`${settings.apiURL}${path}`, {
-    body: request.body,
-    headers: {
-      Accept: "application/json",
-      .../* istanbul ignore next */
-      !isBrowser() ? { "User-Agent": settings.userAgent } : {},
-      ...request.headers
-    },
-    method: request.method
-  });
+	let { path } = request;
+	if (request.urlParams instanceof URLSearchParams) path = path.concat(`?${request.urlParams.toString()}`);
+	return new Request(`${settings.apiURL}${path}`, {
+		body: request.body,
+		headers: {
+			Accept: "application/json",
+			...!isBrowser() ? { "User-Agent": settings.userAgent } : {},
+			...request.headers
+		},
+		method: request.method
+	});
 };
-const asIs = (response) => response;
+var asIs = (response) => response;
+/**
+* Builds a resource fetcher.
+*
+* @param settings - The {@link Settings} object
+* @param httpClient - The HTTP client that should be used to call the API
+* @returns The fetcher
+*
+* @internal
+*/
 const buildFetcher = (settings, httpClient) => {
-  let requestNumber = 0;
-  const prepareRequest = (requestId) => composeRequestInterceptors([
-    ...settings.interceptors.map((obj) => obj.request).filter((obj) => obj),
-    logRequest(requestId, obfuscateInterceptor(obfuscateAuthHeadersEntry))
-  ]);
-  const prepareResponse = (requestId) => composeResponseInterceptors([
-    ...settings.interceptors.map((obj) => obj.response).filter((obj) => obj),
-    logResponse(requestId)
-  ]);
-  const prepareResponseErrors = () => composeResponseErrorInterceptors(
-    settings.interceptors.map((obj) => obj.responseError).filter((obj) => obj)
-  );
-  return async (request, unwrapper = asIs) => {
-    requestNumber += 1;
-    const requestId = `${requestNumber}`;
-    const reqInterceptors = prepareRequest(requestId);
-    const finalRequest = await reqInterceptors(buildRequest(request, settings));
-    try {
-      const response = await httpClient(finalRequest);
-      const resInterceptors = prepareResponse(requestId);
-      const finalResponse = await resInterceptors(response);
-      const resUnmarshaller = responseParser(
-        unwrapper,
-        request.responseType ?? "json"
-      );
-      const unmarshaledResponse = await resUnmarshaller(finalResponse);
-      return unmarshaledResponse;
-    } catch (err) {
-      const resErrorInterceptors = prepareResponseErrors();
-      const handledError = await resErrorInterceptors(finalRequest, err);
-      return unwrapper(handledError);
-    }
-  };
-};
-export {
-  buildFetcher,
-  buildRequest
+	let requestNumber = 0;
+	const prepareRequest = (requestId) => composeRequestInterceptors([...settings.interceptors.map((obj) => obj.request).filter((obj) => obj), logRequest(requestId, obfuscateInterceptor(obfuscateAuthHeadersEntry))]);
+	const prepareResponse = (requestId) => composeResponseInterceptors([...settings.interceptors.map((obj) => obj.response).filter((obj) => obj), logResponse(requestId)]);
+	const prepareResponseErrors = () => composeResponseErrorInterceptors(settings.interceptors.map((obj) => obj.responseError).filter((obj) => obj));
+	return async (request, unwrapper = asIs) => {
+		requestNumber += 1;
+		const requestId = `${requestNumber}`;
+		const finalRequest = await prepareRequest(requestId)(buildRequest(request, settings));
+		try {
+			const response = await httpClient(finalRequest);
+			const finalResponse = await prepareResponse(requestId)(response);
+			return await responseParser(unwrapper, request.responseType ?? "json")(finalResponse);
+		} catch (err) {
+			return unwrapper(await prepareResponseErrors()(finalRequest, err));
+		}
+	};
 };
+export { buildFetcher };

package/dist/scw/fetch/http-dumper.js

@@ -1,20 +1,54 @@
-const toPascalCase = (str) => str.replace(
-  /\w+/g,
-  (word) => `${word[0].toUpperCase()}${word.slice(1).toLowerCase()}`
-);
-const serializeHeadersEntry = ([name, value]) => `${toPascalCase(name)}: ${value}`;
-const serializeHeaders = (headers) => Array.from(headers.entries(), serializeHeadersEntry);
+/**
+* Converts a string to PascalCase.
+*
+* @param str - The input string
+* @returns The string in PascalCase
+*
+* @internal
+*/
+var toPascalCase = (str) => str.replace(/\w+/g, (word) => `${word[0].toUpperCase()}${word.slice(1).toLowerCase()}`);
+/**
+* Converts a Headers entry to string.
+*
+* @param entry - The header entry as a string tuple
+* @returns A serialized string
+*
+* @internal
+*/
+var serializeHeadersEntry = ([name, value]) => `${toPascalCase(name)}: ${value}`;
+/**
+* Converts Headers to safe to log strings (with obfuscated auth secrets).
+*
+* @param headers - The Headers
+* @returns Serialized headers strings
+*
+* @internal
+*/
+var serializeHeaders = (headers) => Array.from(headers.entries(), serializeHeadersEntry);
+/**
+* Dumps a Request into a readable string.
+*
+* @param request - The request
+* @returns The readable string
+*
+* @internal
+*/
 const dumpRequest = async (request) => [
-  `${request.method.toUpperCase()}: ${request.url}`,
-  ...serializeHeaders(request.headers),
-  await request.clone().text()
+	`${request.method.toUpperCase()}: ${request.url}`,
+	...serializeHeaders(request.headers),
+	await request.clone().text()
 ].join("\r\n");
+/**
+* Dumps a Response into a readable string.
+*
+* @param response - The response
+* @returns The readable string
+*
+* @internal
+*/
 const dumpResponse = async (response) => [
-  `HTTP ${response.status} ${response.ok ? "OK" : "NOK"}`,
-  ...serializeHeaders(response.headers),
-  await response.clone().text()
+	`HTTP ${response.status} ${response.ok ? "OK" : "NOK"}`,
+	...serializeHeaders(response.headers),
+	await response.clone().text()
 ].join("\r\n");
-export {
-  dumpRequest,
-  dumpResponse
-};
+export { dumpRequest, dumpResponse };

package/dist/scw/fetch/http-interceptors.d.ts

@@ -11,9 +11,7 @@ import type { RequestInterceptor, ResponseInterceptor } from '../../internal/int
  *
  * @internal
  */
-interface HeaderEntryMapper {
-    (entry: [string, string]): [string, string];
-}
+type HeaderEntryMapper = (entry: [string, string]) => [string, string];
 /**
  * Creates an interceptor to obfuscate the requests.
  *