@scaleway/sdk 1.9.0 → 1.10.0

package/dist/scw/client-ini-factory.js

@@ -37,7 +37,9 @@ const withProfile = profile => settings => {
     newSettings.defaultZone = profile.defaultZone;
   }
   if (hasAuthenticationSecrets(profile)) {
-    newSettings.requestInterceptors = [authenticateWithSecrets(profile), ...settings.requestInterceptors];
+    newSettings.interceptors = [{
+      request: authenticateWithSecrets(profile)
+    }, ...newSettings.interceptors];
   }
   return newSettings;
 };
@@ -102,4 +104,71 @@ const withUserAgentSuffix = userAgent => settings => ({
   userAgent: settings.userAgent ? `${settings.userAgent} ${userAgent}` : userAgent
 });
 
-export { withDefaultPageSize, withHTTPClient, withProfile, withUserAgent, withUserAgentSuffix };
+/**
+ * Instantiates the SDK with additional interceptors.
+ *
+ * @param interceptors - The additional {@link NetworkInterceptors} interceptors
+ * @returns A factory {@link ClientConfig}
+ *
+ * @remarks
+ * It doesn't override the existing interceptors, but instead push more to the list.
+ * This method should be used in conjunction with the initializer `createAdvancedClient`.
+ *
+ * @example
+ * ```
+ * withAdditionalInterceptors([
+ *   {
+ *     request: ({ request }) => {
+ *       console.log(`Do something with ${JSON.stringify(request)}`)
+ *       return request
+ *     },
+ *     response: ({ response }) => {
+ *       console.log(`Do something with ${JSON.stringify(response)}`)
+ *       return response
+ *     },
+ *     responseError: async ({
+ *       request,
+ *       error,
+ *     }: {
+ *       request: Request
+ *       error: unknown
+ *     }) => {
+ *       console.log(
+ *         `Do something with ${JSON.stringify(request)} and ${JSON.stringify(
+ *           error,
+ *         )}`,
+ *       )
+ *       throw error // or return Promise.resolve(someData)
+ *     },
+ *   },
+ * ])
+ * ```
+ *
+ * @public
+ */
+const withAdditionalInterceptors = interceptors => settings => ({
+  ...settings,
+  interceptors: settings.interceptors.concat(interceptors)
+});
+
+/**
+ * Instantiates the SDK with legacy interceptors.
+ */
+/* eslint-disable deprecation/deprecation */
+const withLegacyInterceptors = () => settings => {
+  if (!settings.requestInterceptors && !settings.responseInterceptors) {
+    return settings;
+  }
+  const allInterceptors = settings.interceptors.concat((settings.requestInterceptors ?? []).map(obj => ({
+    request: obj
+  })), (settings.responseInterceptors ?? []).map(obj => ({
+    response: obj
+  })));
+  return {
+    ...settings,
+    interceptors: allInterceptors
+  };
+};
+/* eslint-enable deprecation/deprecation */
+
+export { withAdditionalInterceptors, withDefaultPageSize, withHTTPClient, withLegacyInterceptors, withProfile, withUserAgent, withUserAgentSuffix };

package/dist/scw/client.js

@@ -1,5 +1,5 @@
 import { getLogger } from '../internal/logger/index.js';
-import { withProfile } from './client-ini-factory.js';
+import { withLegacyInterceptors, withProfile } from './client-ini-factory.js';
 import { assertValidSettings } from './client-settings.js';
 import { version, userAgent } from './constants.js';
 import { buildFetcher } from './fetch/build-fetcher.js';
@@ -8,8 +8,7 @@ import { buildFetcher } from './fetch/build-fetcher.js';
 const DEFAULT_SETTINGS = {
   apiURL: 'https://api.scaleway.com',
   httpClient: fetch,
-  requestInterceptors: [],
-  responseInterceptors: [],
+  interceptors: [],
   userAgent
 };
 
@@ -45,7 +44,7 @@ const createAdvancedClient = function () {
   for (var _len = arguments.length, configs = new Array(_len), _key = 0; _key < _len; _key++) {
     configs[_key] = arguments[_key];
   }
-  const settings = configs.reduce((currentSettings, config) => config(currentSettings), DEFAULT_SETTINGS);
+  const settings = configs.concat([withLegacyInterceptors()]).reduce((currentSettings, config) => config(currentSettings), DEFAULT_SETTINGS);
   assertValidSettings(settings);
   getLogger().info(`init Scaleway SDK version ${version}`);
   return {

package/dist/scw/constants.js

@@ -1,4 +1,4 @@
-const version = 'v1.8.0';
+const version = 'v1.9.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 export { userAgent, version };

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

@@ -1,5 +1,5 @@
 import { isBrowser } from '../../helpers/is-browser.js';
-import { composeInterceptors } from '../../internal/interceptors/interceptor.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';
@@ -44,14 +44,28 @@ const asIs = response => response;
  */
 const buildFetcher = (settings, httpClient) => {
   let requestNumber = 0;
-  const prepareRequest = requestId => composeInterceptors([...settings.requestInterceptors, logRequest(requestId, obfuscateInterceptor(obfuscateAuthHeadersEntry))]);
-  const prepareResponse = requestId => composeInterceptors([...settings.responseInterceptors, logResponse(requestId)]);
+  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}`;
-    return Promise.resolve(buildRequest(request, settings)).then(prepareRequest(requestId)).then(httpClient).then(prepareResponse(requestId)).then(responseParser(unwrapper, request.responseType ?? 'json'));
+    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 handledError;
+    }
   };
 };
 

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

@@ -35,8 +35,18 @@ class ObfuscatedRequest extends Request {
  *
  * @internal
  */
-const obfuscateInterceptor = obfuscate => request => new ObfuscatedRequest(request, obfuscate);
-const identity = instance => instance;
+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.
@@ -51,10 +61,15 @@ const logRequest = function (identifier, obfuscate) {
   if (obfuscate === void 0) {
     obfuscate = identity;
   }
-  return async request => {
+  return async _ref3 => {
+    let {
+      request
+    } = _ref3;
     if (shouldLog(LevelResolver[getLogger().logLevel], 'debug')) {
       getLogger().debug(`--------------- Scaleway SDK REQUEST ${identifier} ---------------
-${await dumpRequest(await obfuscate(request))}
+${await dumpRequest(await obfuscate({
+        request
+      }))}
 ---------------------------------------------------------`);
     }
     return request;
@@ -69,7 +84,10 @@ ${await dumpRequest(await obfuscate(request))}
  *
  * @internal
  */
-const logResponse = identifier => async response => {
+const logResponse = identifier => async _ref4 => {
+  let {
+    response
+  } = _ref4;
   if (shouldLog(LevelResolver[getLogger().logLevel], 'debug')) {
     getLogger().debug(`--------------- Scaleway SDK RESPONSE ${identifier} ---------------
 ${await dumpResponse(response)}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "license": "Apache-2.0",
   "description": "Scaleway SDK.",
   "keywords": [
@@ -35,5 +35,5 @@
   "bundledDependencies": [
     "@scaleway/random-name"
   ],
-  "gitHead": "307b3c269ecfde7c1ebb24a92c83bc1fcf35edd4"
+  "gitHead": "3fcccb0fe3ba944bea778ea0d6bb55273ec01db6"
 }

package/dist/internal/interceptors/interceptor.js

@@ -1,13 +0,0 @@
-/**
- * Composes interceptors.
- *
- * @param interceptors - A list of interceptors (that modify an object instance)
- * @returns An async composed interceptor
- *
- * @internal
- */
-const composeInterceptors = interceptors => async instance => interceptors.reduce(async (asyncResult, interceptor) => interceptor(await asyncResult), new Promise(resolve => {
-  resolve(instance);
-}));
-
-export { composeInterceptors };