@scaleway/sdk-client 2.1.0 → 2.2.1

package/dist/_virtual/_rolldown/runtime.js

@@ -0,0 +1,11 @@
+var __defProp = Object.defineProperty;
+var __exportAll = (all, no_symbols) => {
+	let target = {};
+	for (var name in all) __defProp(target, name, {
+		get: all[name],
+		enumerable: true
+	});
+	if (!no_symbols) __defProp(target, Symbol.toStringTag, { value: "Module" });
+	return target;
+};
+export { __exportAll };

package/dist/helpers/is-browser.js

@@ -1,4 +1,2 @@
 const isBrowser = () => typeof window !== "undefined" && typeof window.document !== "undefined";
-export {
-  isBrowser
-};
+export { isBrowser };

package/dist/helpers/is-response.js

@@ -1,4 +1,9 @@
+/**
+* Validates an object is of type Response without using `instanceof`.
+*
+* @remarks Check issue #509 for more context.
+*
+* @internal
+*/
 const isResponse = (obj) => obj !== null && obj !== void 0 && typeof obj === "object" && "status" in obj && typeof obj.status === "number" && "statusText" in obj && typeof obj.statusText === "string" && "headers" in obj && typeof obj.headers === "object" && "body" in obj && typeof obj.body !== "undefined";
-export {
-  isResponse
-};
+export { isResponse };

package/dist/helpers/json.js

@@ -1,46 +1,53 @@
+/**
+* Validates an unknown object is a JSON Object.
+*
+* @internal
+*/
 const isJSONObject = (obj) => {
-  const objT = typeof obj;
-  return obj !== void 0 && obj !== null && objT !== "string" && objT !== "number" && objT !== "boolean" && !Array.isArray(obj) && objT === "object";
+	const objT = typeof obj;
+	return obj !== void 0 && obj !== null && objT !== "string" && objT !== "number" && objT !== "boolean" && !Array.isArray(obj) && objT === "object";
 };
+/**
+* Camelizes a string.
+*
+* @param str - The string to camelize
+* @returns The camelized string
+*
+* @internal
+*/
 const camelize = (str) => {
-  const strLength = str.length;
-  if (strLength <= 0) {
-    return str;
-  }
-  let out = "";
-  for (let capNext = false, index = 0; index < strLength; index += 1) {
-    const char = str.charAt(index);
-    if (char >= "a" && char <= "z") {
-      if (capNext) {
-        out += char.toUpperCase();
-      } else {
-        out += char;
-      }
-    } else if (char >= "A" && char <= "Z") {
-      out += char;
-    } else if (char >= "0" && char <= "9") {
-      out += char;
-    }
-    capNext = char === "_" || char === " " || char === "-" || char === ".";
-  }
-  return out.charAt(0).toLowerCase() + out.substring(1);
+	const strLength = str.length;
+	if (strLength <= 0) return str;
+	let out = "";
+	for (let capNext = false, index = 0; index < strLength; index += 1) {
+		const char = str.charAt(index);
+		if (char >= "a" && char <= "z") if (capNext) out += char.toUpperCase();
+		else out += char;
+		else if (char >= "A" && char <= "Z") out += char;
+		else if (char >= "0" && char <= "9") out += char;
+		capNext = char === "_" || char === " " || char === "-" || char === ".";
+	}
+	return out.charAt(0).toLowerCase() + out.substring(1);
 };
+/**
+* Camelizes keys of an object (deeply).
+*
+* @param obj - The object
+* @param ignoreKeys - The keys to ignore
+* @returns The object with camelized keys
+*
+* @internal
+*/
 const camelizeKeys = (obj, ignoreKeys = []) => {
-  if (Array.isArray(obj)) {
-    return obj.map((v) => camelizeKeys(v, ignoreKeys));
-  }
-  if (obj && typeof obj === "object" && !(obj instanceof Date)) {
-    const result = {};
-    for (const [key, value] of Object.entries(obj)) {
-      const outKey = camelize(key);
-      result[outKey] = ignoreKeys.includes(key) ? value : camelizeKeys(value, ignoreKeys);
-    }
-    return result;
-  }
-  return obj;
-};
-export {
-  camelize,
-  camelizeKeys,
-  isJSONObject
+	if (Array.isArray(obj)) return obj.map((v) => camelizeKeys(v, ignoreKeys));
+	if (obj && typeof obj === "object" && !(obj instanceof Date)) {
+		const result = {};
+		for (const [key, value] of Object.entries(obj)) {
+			const outKey = camelize(key);
+			result[outKey] = ignoreKeys.includes(key) ? value : camelizeKeys(value, ignoreKeys);
+		}
+		return result;
+	}
+	return obj;
 };
+export { camelizeKeys, isJSONObject };

package/dist/helpers/marshalling.js

@@ -1,72 +1,101 @@
+/**
+* Returns the parameter if it's valid as path parameter
+* (string and not empty, or number), else throws an exception.
+*
+* @param name - The parameter name
+* @param param - The parameter value
+* @returns The parameter value
+*
+* @throws TypeError
+* Thrown if the parameter is invalid.
+*
+* @internal
+*/
 function validatePathParam(name, param) {
-  if (typeof param === "string" && param.length > 0) return param;
-  if (typeof param === "number") return param.toString();
-  throw new TypeError(`param ${name} cannot be empty in request`);
+	if (typeof param === "string" && param.length > 0) return param;
+	if (typeof param === "number") return param.toString();
+	throw new TypeError(`param ${name} cannot be empty in request`);
 }
+/**
+* Resolves the ideal parameter and value amongst an optional list.
+*
+* @param list - The list to be looking into
+* @param isRequired - If at least one "one-of" should be found, false by default
+* @returns The parameter and value
+*
+* @throws TypeError
+* Thrown if isRequired is true, and no value or default value is specified.
+*
+* @internal
+*/
 const resolveOneOf = (list, isRequired = false) => {
-  const elt = list.find((obj) => obj.value !== void 0) ?? list.find((obj) => obj.default !== void 0);
-  const value = elt?.value ?? elt?.default;
-  if (elt && value !== void 0) {
-    return { [elt.param]: value };
-  }
-  if (isRequired) {
-    const keyList = list.map((obj) => obj.param).join(" or ");
-    throw new TypeError(`one of ${keyList} must be indicated in the request`);
-  }
-  return {};
+	const elt = list.find((obj) => obj.value !== void 0) ?? list.find((obj) => obj.default !== void 0);
+	const value = elt?.value ?? elt?.default;
+	if (elt && value !== void 0) return { [elt.param]: value };
+	if (isRequired) {
+		const keyList = list.map((obj) => obj.param).join(" or ");
+		throw new TypeError(`one of ${keyList} must be indicated in the request`);
+	}
+	return {};
 };
-const toParamString = (v) => {
-  if (v === null) return null;
-  if (v instanceof Date) return v.toISOString();
-  return v.toString();
+/**
+* Filters defined parameters tuples and converts them to URLSearchParams.
+*
+* @param paramTuples - The key/value pairs
+* @returns URLSearchParams
+*
+* @internal
+*/
+var toParamString = (v) => {
+	if (v === null) return null;
+	if (v instanceof Date) return v.toISOString();
+	return v.toString();
 };
 const urlParams = (...paramTuples) => {
-  const params = new URLSearchParams();
-  for (const [key, value] of paramTuples) {
-    if (typeof key !== "string" || value == null) continue;
-    if (Array.isArray(value)) {
-      for (const inner of value) {
-        const s2 = toParamString(inner);
-        if (s2 !== null) params.append(key, s2);
-      }
-      continue;
-    }
-    const s = toParamString(value);
-    if (s !== null) params.append(key, s);
-  }
-  return params;
+	const params = new URLSearchParams();
+	for (const [key, value] of paramTuples) {
+		if (typeof key !== "string" || value == null) continue;
+		if (Array.isArray(value)) {
+			for (const inner of value) {
+				const s = toParamString(inner);
+				if (s !== null) params.append(key, s);
+			}
+			continue;
+		}
+		const s = toParamString(value);
+		if (s !== null) params.append(key, s);
+	}
+	return params;
 };
+/**
+* Unmarshals data to Date object.
+*
+* @internal
+*/
 const unmarshalDate = (data) => {
-  if (typeof data !== "string") {
-    return void 0;
-  }
-  const date = new Date(data);
-  if (Number.isNaN(date.getTime())) {
-    return void 0;
-  }
-  return date;
+	if (typeof data !== "string") return;
+	const date = new Date(data);
+	if (Number.isNaN(date.getTime())) return;
+	return date;
 };
+/**
+* Unmarshals array of object.
+*
+* @internal
+*/
 const unmarshalArrayOfObject = (data, unmarshaller, emptyFallback = true) => {
-  if (!Array.isArray(data)) {
-    return emptyFallback ? [] : void 0;
-  }
-  return data.map((elt) => unmarshaller(elt));
+	if (!Array.isArray(data)) return emptyFallback ? [] : void 0;
+	return data.map((elt) => unmarshaller(elt));
 };
+/**
+* Unmarshals map of object.
+*
+* @internal
+*/
 const unmarshalMapOfObject = (data, unmarshaller, emptyFallback = true) => {
-  if (!data || typeof data !== "object" || !(data instanceof Object) || Array.isArray(data)) {
-    return emptyFallback ? {} : void 0;
-  }
-  const out = {};
-  for (const [key, value] of Object.entries(data)) {
-    out[key] = unmarshaller(value);
-  }
-  return out;
-};
-export {
-  resolveOneOf,
-  unmarshalArrayOfObject,
-  unmarshalDate,
-  unmarshalMapOfObject,
-  urlParams,
-  validatePathParam
+	if (!data || typeof data !== "object" || !(data instanceof Object) || Array.isArray(data)) return emptyFallback ? {} : void 0;
+	const out = {};
+	for (const [key, value] of Object.entries(data)) out[key] = unmarshaller(value);
+	return out;
 };
+export { resolveOneOf, unmarshalArrayOfObject, unmarshalDate, unmarshalMapOfObject, urlParams, validatePathParam };

package/dist/index.js

@@ -4,55 +4,14 @@ import { resolveOneOf, unmarshalArrayOfObject, unmarshalDate, unmarshalMapOfObje
 import { createExponentialBackoffStrategy, tryAtIntervals, waitForResource } from "./internal/async/interval-retrier.js";
 import { addAsyncHeaderInterceptor } from "./internal/interceptors/helpers.js";
 import { API } from "./scw/api.js";
+import { AUTH_HEADER_KEY, SESSION_HEADER_KEY } from "./scw/constants.js";
 import { authenticateWithSessionToken } from "./scw/auth.js";
+import { Decimal } from "./scw/custom-types.js";
 import { marshalBlobToScwFile, marshalDecimal, marshalMoney, marshalScwFile, marshalTimeSeries, unmarshalAnyRes, unmarshalDecimal, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint } from "./scw/custom-marshalling.js";
 import { enrichForPagination } from "./scw/fetch/resource-paginator.js";
-import { createAdvancedClient, createClient } from "./scw/client.js";
+import "./internals.js";
 import { withAdditionalInterceptors, withDefaultPageSize, withHTTPClient, withProfile, withUserAgent, withUserAgentSuffix } from "./scw/client-ini-factory.js";
-import { AUTH_HEADER_KEY, SESSION_HEADER_KEY } from "./scw/constants.js";
-import { Decimal } from "./scw/custom-types.js";
-import * as index from "./scw/errors/standard/index.js";
+import { createAdvancedClient, createClient } from "./scw/client.js";
+import { standard_exports } from "./scw/errors/standard/index.js";
 import { toApiLocality } from "./scw/locality.js";
-export {
-  API,
-  AUTH_HEADER_KEY,
-  Decimal,
-  index as Errors,
-  SESSION_HEADER_KEY,
-  addAsyncHeaderInterceptor,
-  authenticateWithSessionToken,
-  createAdvancedClient,
-  createClient,
-  createExponentialBackoffStrategy,
-  enableConsoleLogger,
-  enrichForPagination,
-  isJSONObject,
-  marshalBlobToScwFile,
-  marshalDecimal,
-  marshalMoney,
-  marshalScwFile,
-  marshalTimeSeries,
-  resolveOneOf,
-  setLogger,
-  toApiLocality,
-  tryAtIntervals,
-  unmarshalAnyRes,
-  unmarshalArrayOfObject,
-  unmarshalDate,
-  unmarshalDecimal,
-  unmarshalMapOfObject,
-  unmarshalMoney,
-  unmarshalScwFile,
-  unmarshalServiceInfo,
-  unmarshalTimeSeries,
-  unmarshalTimeSeriesPoint,
-  urlParams,
-  validatePathParam,
-  waitForResource,
-  withAdditionalInterceptors,
-  withDefaultPageSize,
-  withHTTPClient,
-  withProfile,
-  withUserAgent,
-  withUserAgentSuffix
-};
+export { API, AUTH_HEADER_KEY, Decimal, standard_exports as Errors, SESSION_HEADER_KEY, addAsyncHeaderInterceptor, authenticateWithSessionToken, createAdvancedClient, createClient, createExponentialBackoffStrategy, enableConsoleLogger, enrichForPagination, isJSONObject, marshalBlobToScwFile, marshalDecimal, marshalMoney, marshalScwFile, marshalTimeSeries, resolveOneOf, setLogger, toApiLocality, tryAtIntervals, unmarshalAnyRes, unmarshalArrayOfObject, unmarshalDate, unmarshalDecimal, unmarshalMapOfObject, unmarshalMoney, unmarshalScwFile, unmarshalServiceInfo, unmarshalTimeSeries, unmarshalTimeSeriesPoint, urlParams, validatePathParam, waitForResource, withAdditionalInterceptors, withDefaultPageSize, withHTTPClient, withProfile, withUserAgent, withUserAgentSuffix };

package/dist/internal/async/interval-retrier.js

@@ -1,54 +1,69 @@
 import { sleep } from "./sleep.js";
-const DEFAULT_TIMEOUT_SECONDS = 300;
-const DEFAULT_MIN_DELAY_SECONDS = 1;
-const DEFAULT_MAX_DELAY_SECONDS = 30;
+var DEFAULT_TIMEOUT_SECONDS = 300;
+var DEFAULT_MIN_DELAY_SECONDS = 1;
+var DEFAULT_MAX_DELAY_SECONDS = 30;
+/**
+* Creates an exponential backoff interval strategy.
+*
+* @param minDelay - The minimum delay before the next try in seconds
+* @param maxDelay - The maximum delay before the next try in seconds
+* @returns An exponential backoff generator
+*
+* @internal
+*/
 function* createExponentialBackoffStrategy(minDelay, maxDelay) {
-  if (minDelay < 1 || maxDelay < 1 || minDelay > maxDelay) {
-    throw new Error(
-      "Waiter: minDelay must be >= 1 and maxDelay must be >= minDelay"
-    );
-  }
-  let attempt = 1;
-  const ceiling = Math.log(maxDelay / minDelay) / Math.log(2) + 1;
-  const randomInRange = (min, max) => min + Math.random() * (max - min);
-  while (true) {
-    if (attempt > ceiling) {
-      yield maxDelay;
-    } else {
-      yield randomInRange(minDelay, minDelay * 2 ** (attempt - 1));
-    }
-    attempt += 1;
-  }
+	if (minDelay < 1 || maxDelay < 1 || minDelay > maxDelay) throw new Error("Waiter: minDelay must be >= 1 and maxDelay must be >= minDelay");
+	let attempt = 1;
+	const ceiling = Math.log(maxDelay / minDelay) / Math.log(2) + 1;
+	const randomInRange = (min, max) => min + Math.random() * (max - min);
+	while (true) {
+		if (attempt > ceiling) yield maxDelay;
+		else yield randomInRange(minDelay, minDelay * 2 ** (attempt - 1));
+		attempt += 1;
+	}
 }
+/**
+* Tries a specific logic several times until it succeeds, timeouts, or throws an exception.
+*
+* @param retry - The function to retry logic between each interval
+* @param strategy - A generated interval strategy iterator
+* @param timeout - The maximum time elapsed before timeout error
+*
+* @throws An timeout exception or error thrown by the logic being run
+*
+* @internal
+*/
 const tryAtIntervals = async (retry, strategy, timeout = DEFAULT_TIMEOUT_SECONDS) => {
-  const timeoutTimestamp = Date.now() + timeout * 1e3;
-  let retryCount = 0;
-  while (Date.now() <= timeoutTimestamp) {
-    retryCount += 1;
-    const delay = strategy.next(retryCount).value * 1e3;
-    if (timeoutTimestamp <= Date.now() + delay) break;
-    await sleep(delay);
-    const { value, done } = await retry();
-    if (done) return value;
-  }
-  throw new Error(`Timeout after ${timeout}s`);
-};
-const waitForResource = (stop, fetcher, request, options, strategy = createExponentialBackoffStrategy(
-  options?.minDelay ?? DEFAULT_MIN_DELAY_SECONDS,
-  options?.maxDelay ?? DEFAULT_MAX_DELAY_SECONDS
-)) => tryAtIntervals(
-  async () => {
-    const value = await fetcher(request);
-    return {
-      done: await stop(value),
-      value
-    };
-  },
-  strategy,
-  options?.timeout
-);
-export {
-  createExponentialBackoffStrategy,
-  tryAtIntervals,
-  waitForResource
+	const timeoutTimestamp = Date.now() + timeout * 1e3;
+	let retryCount = 0;
+	while (Date.now() <= timeoutTimestamp) {
+		retryCount += 1;
+		const delay = strategy.next(retryCount).value * 1e3;
+		if (timeoutTimestamp <= Date.now() + delay) break;
+		await sleep(delay);
+		const { value, done } = await retry();
+		if (done) return value;
+	}
+	throw new Error(`Timeout after ${timeout}s`);
 };
+/**
+* Fetches resource several times until an expected condition is reached, timeouts, or throws an exception.
+*
+* @param stop - The condition to stop waiting
+* @param fetcher - The method to retrieve resource
+* @param request - The resource request options
+* @param options - The retry strategy options
+* @param strategy - An optional custom strategy
+*
+* @returns A promise of resource
+*
+* @public
+*/
+const waitForResource = (stop, fetcher, request, options, strategy = createExponentialBackoffStrategy(options?.minDelay ?? DEFAULT_MIN_DELAY_SECONDS, options?.maxDelay ?? DEFAULT_MAX_DELAY_SECONDS)) => tryAtIntervals(async () => {
+	const value = await fetcher(request);
+	return {
+		done: await stop(value),
+		value
+	};
+}, strategy, options?.timeout);
+export { createExponentialBackoffStrategy, tryAtIntervals, waitForResource };

package/dist/internal/async/sleep.js

@@ -1,6 +1,12 @@
+/**
+* Sleep for a specified number of time.
+*
+* @param ms - The number of milliseconds
+* @returns The sleep promise
+*
+* @internal
+*/
 const sleep = (ms) => new Promise((resolve) => {
-  setTimeout(resolve, ms);
+	setTimeout(resolve, ms);
 });
-export {
-  sleep
-};
+export { sleep };

package/dist/internal/interceptors/composer.js

@@ -1,25 +1,36 @@
-const composeRequestInterceptors = (interceptors) => async (request) => interceptors.reduce(
-  async (asyncResult, interceptor) => interceptor({ request: await asyncResult }),
-  Promise.resolve(request)
-);
-const composeResponseInterceptors = (interceptors) => async (response) => interceptors.reduce(
-  async (asyncResult, interceptor) => interceptor({ response: await asyncResult }),
-  Promise.resolve(response)
-);
+/**
+* Composes request interceptors.
+*
+* @param interceptors - A list of request interceptors
+* @returns An async composed interceptor
+*
+* @internal
+*/
+const composeRequestInterceptors = (interceptors) => async (request) => interceptors.reduce(async (asyncResult, interceptor) => interceptor({ request: await asyncResult }), Promise.resolve(request));
+/**
+* Composes response interceptors.
+*
+* @param interceptors - A list of response interceptors
+* @returns An async composed interceptor
+*
+* @internal
+*/
+const composeResponseInterceptors = (interceptors) => async (response) => interceptors.reduce(async (asyncResult, interceptor) => interceptor({ response: await asyncResult }), Promise.resolve(response));
+/**
+* Compose response error interceptors.
+*
+* @internal
+*/
 const composeResponseErrorInterceptors = (interceptors) => async (request, error) => {
-  let prevError = error;
-  for (const interceptor of interceptors) {
-    try {
-      const res = await interceptor({ request, error: prevError });
-      return res;
-    } catch (err) {
-      prevError = err;
-    }
-  }
-  throw prevError;
-};
-export {
-  composeRequestInterceptors,
-  composeResponseErrorInterceptors,
-  composeResponseInterceptors
+	let prevError = error;
+	for (const interceptor of interceptors) try {
+		return await interceptor({
+			request,
+			error: prevError
+		});
+	} catch (err) {
+		prevError = err;
+	}
+	throw prevError;
 };
+export { composeRequestInterceptors, composeResponseErrorInterceptors, composeResponseInterceptors };

package/dist/internal/interceptors/helpers.js

@@ -1,12 +1,25 @@
+/**
+* Adds an header to a request through an interceptor.
+*
+* @param key - The header key
+* @param value - The header value
+* @returns The Request interceptor
+*
+* @internal
+*/
 const addHeaderInterceptor = (key, value) => ({ request }) => {
-  const clone = request.clone();
-  if (value !== void 0) {
-    clone.headers.append(key, value);
-  }
-  return clone;
+	const clone = request.clone();
+	if (value !== void 0) clone.headers.append(key, value);
+	return clone;
 };
+/**
+* Adds asynchronously an header to a request through an interceptor.
+*
+* @param key - The header key
+* @param value - The header value as a Promise
+* @returns The Request interceptor
+*
+* @internal
+*/
 const addAsyncHeaderInterceptor = (key, getter) => async (request) => addHeaderInterceptor(key, await getter())(request);
-export {
-  addAsyncHeaderInterceptor,
-  addHeaderInterceptor
-};
+export { addAsyncHeaderInterceptor, addHeaderInterceptor };

package/dist/internal/logger/console-logger.js

@@ -1,24 +1,29 @@
 import { LevelResolver, shouldLog } from "./level-resolver.js";
-class ConsoleLogger {
-  constructor(logLevel, prefix = "", output = console) {
-    this.logLevel = logLevel;
-    this.prefix = prefix;
-    this.output = output;
-    this.level = LevelResolver[this.logLevel];
-  }
-  level;
-  makeMethod(method) {
-    return (message) => {
-      if (shouldLog(this.level, method)) {
-        this.output[method](this.prefix ? `${this.prefix} ${message}` : message);
-      }
-    };
-  }
-  debug = this.makeMethod("debug");
-  error = this.makeMethod("error");
-  info = this.makeMethod("info");
-  warn = this.makeMethod("warn");
-}
-export {
-  ConsoleLogger
+/**
+* A Logger using console output.
+*
+* @param logLevel - The logger level name
+* @param prefix - An optional logger message prefix
+* @param output - The output to print logs, using by default the global console object
+*
+* @internal
+*/
+var ConsoleLogger = class {
+	level;
+	constructor(logLevel, prefix = "", output = console) {
+		this.logLevel = logLevel;
+		this.prefix = prefix;
+		this.output = output;
+		this.level = LevelResolver[this.logLevel];
+	}
+	makeMethod(method) {
+		return (message) => {
+			if (shouldLog(this.level, method)) this.output[method](this.prefix ? `${this.prefix} ${message}` : message);
+		};
+	}
+	debug = this.makeMethod("debug");
+	error = this.makeMethod("error");
+	info = this.makeMethod("info");
+	warn = this.makeMethod("warn");
 };
+export { ConsoleLogger };