@scaleway/sdk-client 2.1.0 → 2.2.0

package/dist/scw/client.js

@@ -1,31 +1,82 @@
 import { getLogger } from "../internal/logger/index.js";
-import { withLegacyInterceptors, withAdditionalInterceptors, withProfile } from "./client-ini-factory.js";
-import { assertValidSettings } from "./client-settings.js";
 import { userAgent, version } from "./constants.js";
+import { withAdditionalInterceptors, withLegacyInterceptors, withProfile } from "./client-ini-factory.js";
+import { assertValidSettings } from "./client-settings.js";
 import { buildFetcher } from "./fetch/build-fetcher.js";
-const DEFAULT_SETTINGS = {
-  apiURL: "https://api.scaleway.com",
-  httpClient: fetch,
-  interceptors: [],
-  userAgent
+/** Default {@link Settings} values. */
+var DEFAULT_SETTINGS = {
+	apiURL: "https://api.scaleway.com",
+	httpClient: fetch,
+	interceptors: [],
+	userAgent
 };
+/**
+* Creates a Scaleway client with advanced options.
+* You can either use existing factories
+* (like `withProfile`, `withUserAgentSuffix`, etc)
+* or write your own using the interface `ClientConfig`.
+*
+* @example
+* Creates a client with factories:
+* ```
+* createAdvancedClient(
+*   (obj: Settings) => ({
+*     ...obj,
+*     defaultPageSize: 100 ,
+*     httpClient: myFetchWrapper,
+*   }),
+*   withUserAgentSuffix('bot-name/1.0'),
+* )
+* ```
+*
+* @throws Error
+* Thrown if the setup fails.
+*
+* @public
+*/
 const createAdvancedClient = (...configs) => {
-  const settings = configs.concat([withLegacyInterceptors()]).reduce(
-    (currentSettings, config) => config(currentSettings),
-    DEFAULT_SETTINGS
-  );
-  assertValidSettings(settings);
-  getLogger().info(`init Scaleway SDK version ${version}`);
-  return {
-    fetch: buildFetcher(settings, settings.httpClient),
-    settings
-  };
-};
-const createClient = (settings = {}) => createAdvancedClient(
-  withProfile(settings),
-  withAdditionalInterceptors(settings.interceptors ?? [])
-);
-export {
-  createAdvancedClient,
-  createClient
+	const settings = configs.concat([withLegacyInterceptors()]).reduce((currentSettings, config) => config(currentSettings), DEFAULT_SETTINGS);
+	assertValidSettings(settings);
+	getLogger().info(`init Scaleway SDK version ${version}`);
+	return {
+		fetch: buildFetcher(settings, settings.httpClient),
+		settings
+	};
 };
+/**
+* Creates a Scaleway client with a profile.
+*
+* @example
+* Creates a client with credentials & default values (see https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/):
+* ```
+* import { createClient } from '@scaleway/sdk'
+*
+* createClient({
+*   accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+*   secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+*   defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+*   defaultRegion: 'fr-par',
+*   defaultZone: 'fr-par-1',
+* })
+* ```
+*
+* @example
+* Creates a client by loading values from the environment (see https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/)
+* or the config file created by CLI `scw init` (see https://www.scaleway.com/en/cli/):
+* ```
+* import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+* import { createClient } from '@scaleway/sdk'
+*
+* createClient({
+*   ...await loadProfileFromConfigurationFile(),
+*   defaultZone: 'fr-par-3',
+* })
+* ```
+*
+* @throws Error
+* Thrown if the setup fails.
+*
+* @public
+*/
+const createClient = (settings = {}) => createAdvancedClient(withProfile(settings), withAdditionalInterceptors(settings.interceptors ?? []));
+export { createAdvancedClient, createClient };

package/dist/scw/constants.js

@@ -1,11 +1,6 @@
-import pkg from "../package.json.js";
-const { version } = pkg;
+import package_default from "../package.js";
+const { version } = package_default;
 const userAgent = `scaleway-sdk-js/${version}`;
 const SESSION_HEADER_KEY = "x-session-token";
 const AUTH_HEADER_KEY = "x-auth-token";
-export {
-  AUTH_HEADER_KEY,
-  SESSION_HEADER_KEY,
-  userAgent,
-  version
-};
+export { AUTH_HEADER_KEY, SESSION_HEADER_KEY, userAgent, version };

package/dist/scw/custom-marshalling.js

@@ -1,150 +1,176 @@
-import { isJSONObject, camelizeKeys } from "../helpers/json.js";
+import { camelizeKeys, isJSONObject } from "../helpers/json.js";
 import { unmarshalArrayOfObject, unmarshalDate } from "../helpers/marshalling.js";
 import { fromByteArray } from "../vendor/base64/index.js";
 import { Decimal } from "./custom-types.js";
+/**
+* Unmarshals {@link Money}
+*
+* @internal
+*/
 const unmarshalMoney = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Money' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    currencyCode: data.currency_code,
-    nanos: data.nanos,
-    units: data.units
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Money' failed as data isn't a dictionary.`);
+	return {
+		currencyCode: data.currency_code,
+		nanos: data.nanos,
+		units: data.units
+	};
 };
+/**
+* Unmarshals {@link ServiceInfo}.
+*
+* @internal
+*/
 const unmarshalServiceInfo = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ServiceInfo' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    description: data.description,
-    documentationUrl: data.documentation_url,
-    name: data.name,
-    version: data.version
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ServiceInfo' failed as data isn't a dictionary.`);
+	return {
+		description: data.description,
+		documentationUrl: data.documentation_url,
+		name: data.name,
+		version: data.version
+	};
 };
+/**
+* Unmarshals {@link ScwFile}.
+*
+* @internal
+*/
 const unmarshalScwFile = (data) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'ScwFile' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    content: data.content,
-    contentType: data.content_type,
-    name: data.name
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ScwFile' failed as data isn't a dictionary.`);
+	return {
+		content: data.content,
+		contentType: data.content_type,
+		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) => {
-  if (!Array.isArray(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'TimeSeriesPoint' failed as data isn't an array.`
-    );
-  }
-  return {
-    timestamp: unmarshalDate(data[0]),
-    value: data[1]
-  };
+	if (!Array.isArray(data)) 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) => {
-  if (!isJSONObject(data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'TimeSeries' failed as data isn't a dictionary.`
-    );
-  }
-  return {
-    metadata: data.metadata,
-    name: data.name,
-    points: unmarshalArrayOfObject(data.points, unmarshalTimeSeriesPoint)
-  };
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'TimeSeries' failed as data isn't a dictionary.`);
+	return {
+		metadata: data.metadata,
+		name: data.name,
+		points: unmarshalArrayOfObject(data.points, unmarshalTimeSeriesPoint)
+	};
 };
+/**
+* Unmarshals {@link Decimal}
+*
+* @internal
+*/
 const unmarshalDecimal = (data) => {
-  if (!(typeof data === "object")) {
-    throw new TypeError(
-      `Unmarshalling the type 'Decimal' failed as data isn't an object.`
-    );
-  }
-  if (data === null) {
-    return null;
-  }
-  if (!("value" in data)) {
-    throw new TypeError(
-      `Unmarshalling the type 'Decimal' failed as data object does not have a 'value' key.`
-    );
-  }
-  if (!(typeof data.value === "string")) {
-    throw new TypeError(
-      `Unmarshalling the type 'Decimal' failed as 'value' is not a string.`
-    );
-  }
-  return new Decimal(data.value);
+	if (!(typeof data === "object")) throw new TypeError(`Unmarshalling the type 'Decimal' failed as data isn't an object.`);
+	if (data === null) return null;
+	if (!("value" in data)) throw new TypeError(`Unmarshalling the type 'Decimal' failed as data object does not have a 'value' key.`);
+	if (!(typeof data.value === "string")) throw new TypeError(`Unmarshalling the type 'Decimal' failed as 'value' is not a string.`);
+	return new Decimal(data.value);
 };
+/**
+* Marshals {@link ScwFile}.
+*
+* @internal
+*/
 const marshalScwFile = (obj) => ({
-  content: obj.content,
-  content_type: obj.contentType,
-  name: obj.name
+	content: obj.content,
+	content_type: obj.contentType,
+	name: obj.name
 });
+/**
+* Marshals {@link Blob}.
+*
+* @internal
+*/
 const marshalBlobToScwFile = async (blob) => ({
-  content: fromByteArray(new Uint8Array(await blob.arrayBuffer())),
-  content_type: blob.type,
-  name: "file"
+	content: fromByteArray(new Uint8Array(await blob.arrayBuffer())),
+	content_type: blob.type,
+	name: "file"
 });
+/**
+* Marshals {@link Money}
+*
+* @internal
+*/
 const marshalMoney = (obj) => ({
-  currency_code: obj.currencyCode,
-  nanos: obj.nanos,
-  units: obj.units
+	currency_code: obj.currencyCode,
+	nanos: obj.nanos,
+	units: obj.units
 });
+/**
+* Marshals {@link TimeSeriesPoint}
+*
+* @internal
+*/
 const marshalTimeSeriesPoint = (obj) => ({
-  timestamp: obj.timestamp?.toISOString(),
-  value: obj.value
+	timestamp: obj.timestamp?.toISOString(),
+	value: obj.value
 });
+/**
+* Marshals {@link TimeSeries}
+*
+* @internal
+*/
 const marshalTimeSeries = (obj) => ({
-  metadata: obj.metadata,
-  name: obj.name,
-  points: obj.points.map((elt) => marshalTimeSeriesPoint(elt))
-});
-const marshalDecimal = (obj) => ({
-  value: obj.toString()
+	metadata: obj.metadata,
+	name: obj.name,
+	points: obj.points.map((elt) => marshalTimeSeriesPoint(elt))
 });
+/**
+* Marshals {@link Decimal}
+*
+* @internal
+*/
+const marshalDecimal = (obj) => ({ value: obj.toString() });
+/**
+* Unmarshals record to convert iso dates from string to Dates.
+*
+* @param obj - The input
+* @param keys - The keys requiring a conversion
+* @returns The updated input
+*
+* @internal
+*/
 const unmarshalDates = (obj, keys) => {
-  if (Array.isArray(obj)) {
-    return obj.map((v) => unmarshalDates(v, keys));
-  }
-  if (obj && typeof obj === "object") {
-    const result = {};
-    for (const [key, value] of Object.entries(obj)) {
-      result[key] = typeof value === "string" && keys.includes(key) ? new Date(value) : unmarshalDates(value, keys);
-    }
-    return result;
-  }
-  return obj;
+	if (Array.isArray(obj)) return obj.map((v) => unmarshalDates(v, keys));
+	if (obj && typeof obj === "object") {
+		const result = {};
+		for (const [key, value] of Object.entries(obj)) result[key] = typeof value === "string" && keys.includes(key) ? new Date(value) : unmarshalDates(value, keys);
+		return result;
+	}
+	return obj;
 };
+/**
+* Unmarshals input to a record with camilized keys and instanciated Date.
+*
+* @param obj - The input
+* @param ignoreKeys - The keys which should be not be transformed
+* @param dateKeys - The keys which should be transformed to Date
+* @returns The record
+*
+* @throws TypeError
+* Thrown if the input isn't {@link JSONObject}.
+*
+* @internal
+*/
 const unmarshalAnyRes = (obj, ignoreKeys = [], dateKeys) => {
-  if (!isJSONObject(obj)) {
-    throw new TypeError(`Data isn't a dictionary.`);
-  }
-  return camelizeKeys(
-    dateKeys && dateKeys.length > 0 ? unmarshalDates(obj, dateKeys) : obj,
-    ignoreKeys
-  );
-};
-export {
-  marshalBlobToScwFile,
-  marshalDecimal,
-  marshalMoney,
-  marshalScwFile,
-  marshalTimeSeries,
-  marshalTimeSeriesPoint,
-  unmarshalAnyRes,
-  unmarshalDates,
-  unmarshalDecimal,
-  unmarshalMoney,
-  unmarshalScwFile,
-  unmarshalServiceInfo,
-  unmarshalTimeSeries,
-  unmarshalTimeSeriesPoint
+	if (!isJSONObject(obj)) throw new TypeError(`Data isn't a dictionary.`);
+	return camelizeKeys(dateKeys && dateKeys.length > 0 ? unmarshalDates(obj, dateKeys) : obj, ignoreKeys);
 };
+export { marshalBlobToScwFile, marshalDecimal, marshalMoney, marshalScwFile, marshalTimeSeries, unmarshalAnyRes, unmarshalDecimal, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint };

package/dist/scw/custom-types.js

@@ -1,11 +1,12 @@
-class Decimal {
-  str;
-  constructor(v) {
-    this.str = v;
-  }
-  toString = () => this.str;
-  marshal = () => ({ value: this.str });
-}
-export {
-  Decimal
+/** A representation of a decimal value, such as 2.5.
+* Comparable to language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.
+* Lookup protobuf google.type.Decimal for details  */
+var Decimal = class {
+	str;
+	constructor(v) {
+		this.str = v;
+	}
+	toString = () => this.str;
+	marshal = () => ({ value: this.str });
 };
+export { Decimal };

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

@@ -1,76 +1,98 @@
+import { ScalewayError } from "./scw-error.js";
+import { InvalidArgumentsError } from "./standard/invalid-arguments-error.js";
+import { QuotasExceededError } from "./standard/quotas-exceeded-error.js";
 import { mapInvalidRequestFromJSON } from "./non-standard/invalid-request-mapper.js";
+import { ResourceNotFoundError } from "./standard/resource-not-found-error.js";
 import { mapUnknownResourceFromJSON } 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":
-      error = DeniedAuthenticationError;
-      break;
-    case "invalid_arguments":
-      error = InvalidArgumentsError;
-      break;
-    case "out_of_stock":
-      error = OutOfStockError;
-      break;
-    case "permissions_denied":
-      error = PermissionsDeniedError;
-      break;
-    case "precondition_failed":
-      error = PreconditionFailedError;
-      break;
-    case "quotas_exceeded":
-      error = QuotasExceededError;
-      break;
-    case "expired":
-      error = ResourceExpiredError;
-      break;
-    case "not_found":
-      error = ResourceNotFoundError;
-      break;
-    case "locked":
-      error = ResourceLockedError;
-      break;
-    case "transient_state":
-      error = TransientStateError;
-      break;
-    case "already_exists":
-      error = AlreadyExistsError;
-      break;
-    case "too_many_requests":
-      error = TooManyRequestsError;
-      break;
-    default:
-      return null;
-  }
-  return error.fromJSON(status, body);
+/**
+* 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
+*/
+var unmarshalStandardError = (type, status, body) => {
+	let error;
+	switch (type) {
+		case "denied_authentication":
+			error = DeniedAuthenticationError;
+			break;
+		case "invalid_arguments":
+			error = InvalidArgumentsError;
+			break;
+		case "out_of_stock":
+			error = OutOfStockError;
+			break;
+		case "permissions_denied":
+			error = PermissionsDeniedError;
+			break;
+		case "precondition_failed":
+			error = PreconditionFailedError;
+			break;
+		case "quotas_exceeded":
+			error = QuotasExceededError;
+			break;
+		case "expired":
+			error = ResourceExpiredError;
+			break;
+		case "not_found":
+			error = ResourceNotFoundError;
+			break;
+		case "locked":
+			error = ResourceLockedError;
+			break;
+		case "transient_state":
+			error = TransientStateError;
+			break;
+		case "already_exists":
+			error = AlreadyExistsError;
+			break;
+		case "too_many_requests":
+			error = TooManyRequestsError;
+			break;
+		default: return null;
+	}
+	return error.fromJSON(status, body);
 };
-const unmarshalNonStandardError = (type, status, body) => {
-  switch (type) {
-    case "unknown_resource":
-      return mapUnknownResourceFromJSON(status, body);
-    case "invalid_request_error":
-      return mapInvalidRequestFromJSON(status, body);
-    default:
-      return null;
-  }
+/**
+* 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
+*/
+var unmarshalNonStandardError = (type, status, body) => {
+	switch (type) {
+		case "unknown_resource": return mapUnknownResourceFromJSON(status, body);
+		case "invalid_request_error": return mapInvalidRequestFromJSON(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));
-  return parsableError || new ScalewayError(status, body);
-};
-export {
-  parseScalewayError
+	return typeof body.type === "string" && (unmarshalStandardError(body.type, status, body) ?? unmarshalNonStandardError(body.type, status, body)) || new ScalewayError(status, body);
 };
+export { parseScalewayError };

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

@@ -1,34 +1,25 @@
+import { isRecordOfStringArray } from "../types.js";
 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
+*/
 const mapInvalidRequestFromJSON = (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 : ""
-      }
-    ]);
-  }
-  const fields = obj.fields && isRecordOfStringArray(obj.fields) ? obj.fields : {};
-  const fieldsMessages = Object.entries(fields);
-  if (fieldsMessages.length) {
-    return new InvalidArgumentsError(
-      status,
-      obj,
-      fieldsMessages.flatMap(
-        ([argumentName, messages]) => messages.map((helpMessage) => ({
-          argumentName,
-          helpMessage,
-          reason: "constraint"
-        }))
-      )
-    );
-  }
-  return new ScalewayError(status, obj);
-};
-export {
-  mapInvalidRequestFromJSON
+	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.flatMap(([argumentName, messages]) => messages.map((helpMessage) => ({
+		argumentName,
+		helpMessage,
+		reason: "constraint"
+	}))));
+	return new ScalewayError(status, obj);
 };
+export { mapInvalidRequestFromJSON };