@scaleway/sdk 1.9.0 → 1.10.1

package/dist/api/webhosting/v1alpha1/api.gen.js

@@ -10,14 +10,15 @@ const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/** Webhosting API. */
+/** Web Hosting API. */
 class API extends API$1 {
   constructor() {
     var _this;
     super(...arguments);
     _this = this;
     /**
-     * Create a hosting.
+     * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer
+     * type required via the `offer_id` parameter.
      *
      * @param request - The request {@link CreateHostingRequest}
      * @returns A Promise of Hosting
@@ -39,7 +40,9 @@ class API extends API$1 {
       }, unmarshalListHostingsResponse);
     };
     /**
-     * List all hostings.
+     * List all Web Hosting plans. List all of your existing Web Hosting plans.
+     * Various filters are available to limit the results, including filtering by
+     * domain, status, tag and Project ID.
      *
      * @param request - The request {@link ListHostingsRequest}
      * @returns A Promise of ListHostingsResponse
@@ -51,7 +54,8 @@ class API extends API$1 {
       return enrichForPagination('hostings', _this.pageOfListHostings, request);
     };
     /**
-     * Get a hosting. Get the details of a Hosting with the given ID.
+     * Get a Web Hosting plan. Get the details of one of your existing Web Hosting
+     * plans, specified by its `hosting_id`.
      *
      * @param request - The request {@link GetHostingRequest}
      * @returns A Promise of Hosting
@@ -69,7 +73,9 @@ class API extends API$1 {
      */
     this.waitForHosting = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!HOSTING_TRANSIENT_STATUSES.includes(res.status))), this.getHosting, request, options);
     /**
-     * Update a hosting.
+     * Update a Web Hosting plan. Update the details of one of your existing Web
+     * Hosting plans, specified by its `hosting_id`. You can update parameters
+     * including the contact email address, tags, options and offer.
      *
      * @param request - The request {@link UpdateHostingRequest}
      * @returns A Promise of Hosting
@@ -81,7 +87,10 @@ class API extends API$1 {
       path: `/webhosting/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hostings/${validatePathParam('hostingId', request.hostingId)}`
     }, unmarshalHosting);
     /**
-     * Delete a hosting. Delete a hosting with the given ID.
+     * Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its
+     * `hosting_id`. Note that deletion is not immediate: it will take place at
+     * the end of the calendar month, after which time your Web Hosting plan and
+     * all its data (files and emails) will be irreversibly lost.
      *
      * @param request - The request {@link DeleteHostingRequest}
      * @returns A Promise of Hosting
@@ -91,7 +100,12 @@ class API extends API$1 {
       path: `/webhosting/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hostings/${validatePathParam('hostingId', request.hostingId)}`
     }, unmarshalHosting);
     /**
-     * Restore a hosting. Restore a hosting with the given ID.
+     * Restore a Web Hosting plan. When you [delete a Web Hosting
+     * plan](#path-hostings-delete-a-hosting), definitive deletion does not take
+     * place until the end of the calendar month. In the time between initiating
+     * the deletion, and definitive deletion at the end of the month, you can
+     * choose to **restore** the Web Hosting plan, using this endpoint and
+     * specifying its `hosting_id`.
      *
      * @param request - The request {@link RestoreHostingRequest}
      * @returns A Promise of Hosting
@@ -103,8 +117,8 @@ class API extends API$1 {
       path: `/webhosting/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/hostings/${validatePathParam('hostingId', request.hostingId)}/restore`
     }, unmarshalHosting);
     /**
-     * Get the DNS records. The set of DNS record of a specific domain associated
-     * to a hosting.
+     * Get DNS records. Get the set of DNS records of a specified domain
+     * associated with a Web Hosting plan.
      *
      * @param request - The request {@link GetDomainDnsRecordsRequest}
      * @returns A Promise of DnsRecords
@@ -114,7 +128,8 @@ class API extends API$1 {
       path: `/webhosting/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/domains/${validatePathParam('domain', request.domain)}/dns-records`
     }, unmarshalDnsRecords);
     /**
-     * List all offers.
+     * List all offers. List the different Web Hosting offers, and their options,
+     * available to order from Scaleway.
      *
      * @param request - The request {@link ListOffersRequest}
      * @returns A Promise of ListOffersResponse

package/dist/index.cjs

@@ -71,8 +71,6 @@ const enableConsoleLogger = (logLevel = 'warn', prefix = 'scaleway-sdk-js:') =>
  */
 const getLogger = () => sdkLogger;
 
-/** Request Interceptor. */
-
 /**
  * Adds an header to a request through an interceptor.
  *
@@ -82,7 +80,9 @@ const getLogger = () => sdkLogger;
  *
  * @internal
  */
-const addHeaderInterceptor = (key, value) => request => {
+const addHeaderInterceptor = (key, value) => ({
+  request
+}) => {
   const clone = request.clone();
   if (value !== undefined) {
     clone.headers.append(key, value);
@@ -197,6 +197,8 @@ const AUTH_HEADER_KEY = 'x-auth-token';
  * @param getToken - The token accessor
  * @returns The request interceptor
  *
+ * @deprecated Please use addAsyncHeaderInterceptor instead.
+ *
  * @internal
  */
 const authenticateWithSessionToken = getToken => addAsyncHeaderInterceptor(SESSION_HEADER_KEY, getToken);
@@ -286,7 +288,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;
 };
@@ -351,6 +355,73 @@ const withUserAgentSuffix = userAgent => settings => ({
   userAgent: settings.userAgent ? `${settings.userAgent} ${userAgent}` : userAgent
 });
 
+/**
+ * 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 */
+
 /**
  * Holds default values of settings.
  *
@@ -426,22 +497,55 @@ const assertValidSettings = obj => {
   }
 };
 
-const version = 'v1.8.0';
+const version = 'v1.10.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
 
 /**
- * Composes interceptors.
+ * Composes request interceptors.
  *
- * @param interceptors - A list of interceptors (that modify an object instance)
+ * @param interceptors - A list of request interceptors
  * @returns An async composed interceptor
  *
  * @internal
  */
-const composeInterceptors = interceptors => async instance => interceptors.reduce(async (asyncResult, interceptor) => interceptor(await asyncResult), new Promise(resolve => {
-  resolve(instance);
-}));
+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;
+};
 
 /**
  * Converts a string to PascalCase.
@@ -526,8 +630,12 @@ class ObfuscatedRequest extends Request {
  *
  * @internal
  */
-const obfuscateInterceptor = obfuscate => request => new ObfuscatedRequest(request, obfuscate);
-const identity = instance => instance;
+const obfuscateInterceptor = obfuscate => ({
+  request
+}) => new ObfuscatedRequest(request, obfuscate);
+const identity = ({
+  request
+}) => request;
 
 /**
  * Creates an interceptor to log the requests.
@@ -538,10 +646,14 @@ const identity = instance => instance;
  *
  * @internal
  */
-const logRequest = (identifier, obfuscate = identity) => async request => {
+const logRequest = (identifier, obfuscate = identity) => async ({
+  request
+}) => {
   if (shouldLog(LevelResolver[getLogger().logLevel], 'debug')) {
     getLogger().debug(`--------------- Scaleway SDK REQUEST ${identifier} ---------------
-${await dumpRequest(await obfuscate(request))}
+${await dumpRequest(await obfuscate({
+      request
+    }))}
 ---------------------------------------------------------`);
   }
   return request;
@@ -555,7 +667,9 @@ ${await dumpRequest(await obfuscate(request))}
  *
  * @internal
  */
-const logResponse = identifier => async response => {
+const logResponse = identifier => async ({
+  response
+}) => {
   if (shouldLog(LevelResolver[getLogger().logLevel], 'debug')) {
     getLogger().debug(`--------------- Scaleway SDK RESPONSE ${identifier} ---------------
 ${await dumpResponse(response)}
@@ -1358,11 +1472,25 @@ 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 (request, 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 unwrapper(handledError);
+    }
   };
 };
 
@@ -1370,8 +1498,7 @@ const buildFetcher = (settings, httpClient) => {
 const DEFAULT_SETTINGS = {
   apiURL: 'https://api.scaleway.com',
   httpClient: fetch,
-  requestInterceptors: [],
-  responseInterceptors: [],
+  interceptors: [],
   userAgent
 };
 
@@ -1404,7 +1531,7 @@ const DEFAULT_SETTINGS = {
  * @public
  */
 const createAdvancedClient = (...configs) => {
-  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 {
@@ -21325,13 +21452,14 @@ const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/** Webhosting API. */
+/** Web Hosting API. */
 class API extends API$q {
   /** Lists the available regions of the API. */
   static LOCALITIES = ['fr-par'];
 
   /**
-   * Create a hosting.
+   * Order a Web Hosting plan. Order a Web Hosting plan, specifying the offer
+   * type required via the `offer_id` parameter.
    *
    * @param request - The request {@link CreateHostingRequest}
    * @returns A Promise of Hosting
@@ -21349,7 +21477,9 @@ class API extends API$q {
   }, unmarshalListHostingsResponse);
 
   /**
-   * List all hostings.
+   * List all Web Hosting plans. List all of your existing Web Hosting plans.
+   * Various filters are available to limit the results, including filtering by
+   * domain, status, tag and Project ID.
    *
    * @param request - The request {@link ListHostingsRequest}
    * @returns A Promise of ListHostingsResponse
@@ -21357,7 +21487,8 @@ class API extends API$q {
   listHostings = (request = {}) => enrichForPagination('hostings', this.pageOfListHostings, request);
 
   /**
-   * Get a hosting. Get the details of a Hosting with the given ID.
+   * Get a Web Hosting plan. Get the details of one of your existing Web Hosting
+   * plans, specified by its `hosting_id`.
    *
    * @param request - The request {@link GetHostingRequest}
    * @returns A Promise of Hosting
@@ -21377,7 +21508,9 @@ class API extends API$q {
   waitForHosting = (request, options) => waitForResource(options?.stop ?? (res => Promise.resolve(!HOSTING_TRANSIENT_STATUSES.includes(res.status))), this.getHosting, request, options);
 
   /**
-   * Update a hosting.
+   * Update a Web Hosting plan. Update the details of one of your existing Web
+   * Hosting plans, specified by its `hosting_id`. You can update parameters
+   * including the contact email address, tags, options and offer.
    *
    * @param request - The request {@link UpdateHostingRequest}
    * @returns A Promise of Hosting
@@ -21390,7 +21523,10 @@ class API extends API$q {
   }, unmarshalHosting);
 
   /**
-   * Delete a hosting. Delete a hosting with the given ID.
+   * Delete a Web Hosting plan. Delete a Web Hosting plan, specified by its
+   * `hosting_id`. Note that deletion is not immediate: it will take place at
+   * the end of the calendar month, after which time your Web Hosting plan and
+   * all its data (files and emails) will be irreversibly lost.
    *
    * @param request - The request {@link DeleteHostingRequest}
    * @returns A Promise of Hosting
@@ -21401,7 +21537,12 @@ class API extends API$q {
   }, unmarshalHosting);
 
   /**
-   * Restore a hosting. Restore a hosting with the given ID.
+   * Restore a Web Hosting plan. When you [delete a Web Hosting
+   * plan](#path-hostings-delete-a-hosting), definitive deletion does not take
+   * place until the end of the calendar month. In the time between initiating
+   * the deletion, and definitive deletion at the end of the month, you can
+   * choose to **restore** the Web Hosting plan, using this endpoint and
+   * specifying its `hosting_id`.
    *
    * @param request - The request {@link RestoreHostingRequest}
    * @returns A Promise of Hosting
@@ -21414,8 +21555,8 @@ class API extends API$q {
   }, unmarshalHosting);
 
   /**
-   * Get the DNS records. The set of DNS record of a specific domain associated
-   * to a hosting.
+   * Get DNS records. Get the set of DNS records of a specified domain
+   * associated with a Web Hosting plan.
    *
    * @param request - The request {@link GetDomainDnsRecordsRequest}
    * @returns A Promise of DnsRecords
@@ -21426,7 +21567,8 @@ class API extends API$q {
   }, unmarshalDnsRecords);
 
   /**
-   * List all offers.
+   * List all offers. List the different Web Hosting offers, and their options,
+   * available to order from Scaleway.
    *
    * @param request - The request {@link ListOffersRequest}
    * @returns A Promise of ListOffersResponse
@@ -21497,6 +21639,7 @@ exports.TransactionalEmail = index$3;
 exports.VPC = index$2;
 exports.VPCGW = index$1;
 exports.Webhosting = index;
+exports.addAsyncHeaderInterceptor = addAsyncHeaderInterceptor;
 exports.authenticateWithSessionToken = authenticateWithSessionToken;
 exports.createAdvancedClient = createAdvancedClient;
 exports.createClient = createClient;
@@ -21519,6 +21662,7 @@ exports.unmarshalTimeSeriesPoint = unmarshalTimeSeriesPoint;
 exports.urlParams = urlParams;
 exports.validatePathParam = validatePathParam;
 exports.waitForResource = waitForResource;
+exports.withAdditionalInterceptors = withAdditionalInterceptors;
 exports.withDefaultPageSize = withDefaultPageSize;
 exports.withHTTPClient = withHTTPClient;
 exports.withProfile = withProfile;