@scaleway/sdk 3.0.0-alpha.0 → 3.1.1

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

@@ -1,13 +0,0 @@
-export { ScalewayError } from '../scw-error.js';
-export { AlreadyExistsError } from './already-exists-error.js';
-export { DeniedAuthenticationError } from './denied-authentication-error.js';
-export { InvalidArgumentsError } from './invalid-arguments-error.js';
-export { OutOfStockError } from './out-of-stock-error.js';
-export { PermissionsDeniedError } from './permissions-denied-error.js';
-export { PreconditionFailedError } from './precondition-failed-error.js';
-export { QuotasExceededError } from './quotas-exceeded-error.js';
-export { ResourceExpiredError } from './resource-expired-error.js';
-export { ResourceLockedError } from './resource-locked-error.js';
-export { ResourceNotFoundError } from './resource-not-found-error.js';
-export { TooManyRequestsError } from './too-many-requests-error.js';
-export { TransientStateError } from './transient-state-error.js';

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

@@ -1,67 +0,0 @@
-import { isJSONObject } from '../../../helpers/json.js';
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * Details of an {@link InvalidArgumentsError} error.
- *
- * @public
- */
-
-/**
- * Build the default message for {@link InvalidArgumentsError}.
- *
- * @param list - The list of {@link InvalidArgumentsErrorDetails}
- * @returns The error message
- *
- * @internal
- */
-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('; ')}`;
-};
-
-/**
- * InvalidArguments error happens when one or many fields are invalid in the request message.
- *
- * @public
- */
-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 : undefined,
-      reason: detail.reason
-    }) : list, []));
-  }
-}
-
-export { InvalidArgumentsError };

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

@@ -1,22 +0,0 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * OutOfStock error happens when stocks are empty for the resource.
- *
- * @public
- */
-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,48 +0,0 @@
-import { isJSONObject } from '../../../helpers/json.js';
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * Details of an {@link PermissionsDeniedError} error.
- *
- * @public
- */
-
-/**
- * Build the default message for {@link PermissionsDeniedError}.
- *
- * @param list - The list of {@link PermissionsDeniedErrorDetails}
- * @returns The error message
- *
- * @internal
- */
-const buildMessage = list => `insufficient permissions: ${list.map(_ref => {
-  let {
-    action,
-    resource
-  } = _ref;
-  return `${action} ${resource}`;
-}).join('; ')}`;
-
-/**
- * PermissionsDenied error happens when one or many permissions are not accorded to the user making the request.
- *
- * @public
- */
-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,42 +0,0 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * 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
- */
-const buildMessage = (precondition, helpMessage) => {
-  let message = `precondition failed: ${precondition}`;
-  if (typeof helpMessage === 'string' && helpMessage.length > 0) {
-    message = message.concat(', ', helpMessage);
-  }
-  return message;
-};
-
-/**
- * PreconditionFailed error is used when a precondition is not respected.
- *
- * @public
- */
-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 };

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

@@ -1,68 +0,0 @@
-import { isJSONObject } from '../../../helpers/json.js';
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * Scope of an {@link QuotasExceededErrorDetails} error.
- *
- * @public
- */
-
-/**
- * Details of an {@link QuotasExceededError} error.
- *
- * @public
- */
-
-/**
- * Build the default message for {@link QuotasExceededError}.
- *
- * @param list - The list of {@link QuotasExceededErrorDetails}
- * @returns The error message
- *
- * @internal
- */
-const buildMessage = list => `quota(s) exceeded: ${list.map(details => {
-  const message = `${details.resource} has reached its quota (${details.current}/${details.quota})`;
-  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 undefined;
-};
-
-/**
- * QuotasExceeded error happens when one or many resource exceed quotas during the creation of a resource.
- *
- * @public
- */
-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,26 +0,0 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * ResourceExpired error happens when trying to access a resource that has expired.
- *
- * @public
- */
-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,25 +0,0 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * ResourceLocked error happens when a resource is locked by trust and safety.
- *
- * @public
- */
-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,25 +0,0 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * ResourceNotFound error happens when getting a resource that does not exist anymore.
- *
- * @public
- */
-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,70 +0,0 @@
-import { isJSONObject } from '../../../helpers/json.js';
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * Quota policy of {@link TooManyRequestsError}.
- *
- * @public
- */
-
-/**
- * Build the default message for {@link TooManyRequestsError}.
- *
- * @internal
- */
-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;
-};
-
-/**
- * TooManyRequestsError error happens when fetching too many times a resource.
- *
- * @public
- */
-class TooManyRequestsError extends ScalewayError {
-  constructor(status, body, helpMessage, limit, /** The number of seconds until the quota resets */
-  resetSeconds, /** The timestamp when the quota resets */
-  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 : undefined
-      };
-    }
-    return new TooManyRequestsError(status, obj, obj.help_message, limit, typeof obj.reset_seconds === 'number' ? obj.reset_seconds : undefined, typeof obj.reset_at === 'string' ? new Date(obj.reset_at) : undefined);
-  }
-}
-
-export { TooManyRequestsError };

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

@@ -1,26 +0,0 @@
-import { ScalewayError } from '../scw-error.js';
-
-/**
- * TransientState error happens when trying to perform an action on a resource in a transient state.
- *
- * @public
- */
-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,23 +0,0 @@
-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') !== undefined) {
-      return false;
-    }
-  }
-  return true;
-};
-
-export { isRecordOfStringArray };

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

@@ -1,72 +0,0 @@
-import { isBrowser } from '../../helpers/is-browser.js';
-import { composeRequestInterceptors, composeResponseInterceptors, composeResponseErrorInterceptors } from '../../internal/interceptors/composer.js';
-import { obfuscateAuthHeadersEntry } from '../auth.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
-  });
-};
-const 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 function (request, unwrapper) {
-    if (unwrapper === void 0) {
-      unwrapper = asIs;
-    }
-    const requestId = `${requestNumber += 1}`;
-    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 };

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

@@ -1,54 +0,0 @@
-/**
- * Converts a string to PascalCase.
- *
- * @param str - The input string
- * @returns The string in PascalCase
- *
- * @internal
- */
-const 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
- */
-const serializeHeadersEntry = _ref => {
-  let [name, value] = _ref;
-  return `${toPascalCase(name)}: ${value}`;
-};
-
-/**
- * Converts Headers to safe to log strings (with obfuscated auth secrets).
- *
- * @param headers - The Headers
- * @returns Serialized headers strings
- *
- * @internal
- */
-const 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()].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()].join('\r\n');
-
-export { dumpRequest, dumpResponse };

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

@@ -1,99 +0,0 @@
-import { getLogger } from '../../internal/logger/index.js';
-import { shouldLog, LevelResolver } from '../../internal/logger/level-resolver.js';
-import { dumpRequest, dumpResponse } from './http-dumper.js';
-
-/**
- * Mapper of an header entry.
- *
- * @internal
- */
-
-/**
- * HTTP Request with obfuscated secrets.
- *
- * @internal
- */
-class ObfuscatedRequest extends Request {
-  constructor(request, obfuscate) {
-    super(request);
-    this.request = request;
-    this.obfuscate = obfuscate;
-  }
-  get headers() {
-    return new Headers(Array.from(this.request.headers, this.obfuscate));
-  }
-  clone() {
-    return new ObfuscatedRequest(this.request, this.obfuscate);
-  }
-}
-
-/**
- * Creates an interceptor to obfuscate the requests.
- *
- * @param obfuscate - The Header entries obfuscator mapper
- * @returns The obfuscated Request
- *
- * @internal
- */
-const obfuscateInterceptor = obfuscate => _ref => {
-  let {
-    request
-  } = _ref;
-  return new ObfuscatedRequest(request, obfuscate);
-};
-const identity = _ref2 => {
-  let {
-    request
-  } = _ref2;
-  return request;
-};
-
-/**
- * Creates an interceptor to log the requests.
- *
- * @param identifier - The request identifier
- * @param obfuscate - The obfuscation interceptor
- * @returns The interceptor
- *
- * @internal
- */
-const logRequest = function (identifier, obfuscate) {
-  if (obfuscate === void 0) {
-    obfuscate = identity;
-  }
-  return async _ref3 => {
-    let {
-      request
-    } = _ref3;
-    if (shouldLog(LevelResolver[getLogger().logLevel], 'debug')) {
-      getLogger().debug(`--------------- Scaleway SDK REQUEST ${identifier} ---------------
-${await dumpRequest(await obfuscate({
-        request
-      }))}
----------------------------------------------------------`);
-    }
-    return request;
-  };
-};
-
-/**
- * Creates an interceptor to log the responses.
- *
- * @param identifier - The request identifier
- * @returns The interceptor
- *
- * @internal
- */
-const logResponse = identifier => async _ref4 => {
-  let {
-    response
-  } = _ref4;
-  if (shouldLog(LevelResolver[getLogger().logLevel], 'debug')) {
-    getLogger().debug(`--------------- Scaleway SDK RESPONSE ${identifier} ---------------
-${await dumpResponse(response)}
----------------------------------------------------------`);
-  }
-  return response;
-};
-
-export { logRequest, logResponse, obfuscateInterceptor };