@algolia/monitoring 1.0.0-alpha.9 → 1.0.0-beta.10

package/dist/monitoring.esm.browser.js

@@ -26,14 +26,35 @@ function createBrowserLocalStorageCache(options) {
   function getNamespace() {
     return JSON.parse(getStorage().getItem(namespaceKey) || '{}');
   }
+  function setNamespace(namespace) {
+    getStorage().setItem(namespaceKey, JSON.stringify(namespace));
+  }
+  function removeOutdatedCacheItems() {
+    const timeToLive = options.timeToLive ? options.timeToLive * 1000 : null;
+    const namespace = getNamespace();
+    const filteredNamespaceWithoutOldFormattedCacheItems = Object.fromEntries(Object.entries(namespace).filter(([, cacheItem]) => {
+      return cacheItem.timestamp !== undefined;
+    }));
+    setNamespace(filteredNamespaceWithoutOldFormattedCacheItems);
+    if (!timeToLive) {
+      return;
+    }
+    const filteredNamespaceWithoutExpiredItems = Object.fromEntries(Object.entries(filteredNamespaceWithoutOldFormattedCacheItems).filter(([, cacheItem]) => {
+      const currentTimestamp = new Date().getTime();
+      const isExpired = cacheItem.timestamp + timeToLive < currentTimestamp;
+      return !isExpired;
+    }));
+    setNamespace(filteredNamespaceWithoutExpiredItems);
+  }
   return {
     get(key, defaultValue, events = {
       miss: () => Promise.resolve()
     }) {
       return Promise.resolve().then(() => {
-        const keyAsString = JSON.stringify(key);
-        const value = getNamespace()[keyAsString];
-        return Promise.all([value || defaultValue(), value !== undefined]);
+        removeOutdatedCacheItems();
+        return getNamespace()[JSON.stringify(key)];
+      }).then(value => {
+        return Promise.all([value ? value.value : defaultValue(), value !== undefined]);
       }).then(([value, exists]) => {
         return Promise.all([value, exists || events.miss(value)]);
       }).then(([value]) => value);
@@ -41,7 +62,10 @@ function createBrowserLocalStorageCache(options) {
     set(key, value) {
       return Promise.resolve().then(() => {
         const namespace = getNamespace();
-        namespace[JSON.stringify(key)] = value;
+        namespace[JSON.stringify(key)] = {
+          timestamp: new Date().getTime(),
+          value
+        };
         getStorage().setItem(namespaceKey, JSON.stringify(namespace));
         return value;
       });
@@ -171,33 +195,27 @@ function createStatefulHost(host, status = 'up') {
   };
 }
 
-function _defineProperty(obj, key, value) {
-  key = _toPropertyKey(key);
-  if (key in obj) {
-    Object.defineProperty(obj, key, {
-      value: value,
-      enumerable: true,
-      configurable: true,
-      writable: true
-    });
-  } else {
-    obj[key] = value;
-  }
-  return obj;
+function _defineProperty(e, r, t) {
+  return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
+    value: t,
+    enumerable: !0,
+    configurable: !0,
+    writable: !0
+  }) : e[r] = t, e;
 }
-function _toPrimitive(input, hint) {
-  if (typeof input !== "object" || input === null) return input;
-  var prim = input[Symbol.toPrimitive];
-  if (prim !== undefined) {
-    var res = prim.call(input, hint || "default");
-    if (typeof res !== "object") return res;
+function _toPrimitive(t, r) {
+  if ("object" != typeof t || !t) return t;
+  var e = t[Symbol.toPrimitive];
+  if (void 0 !== e) {
+    var i = e.call(t, r || "default");
+    if ("object" != typeof i) return i;
     throw new TypeError("@@toPrimitive must return a primitive value.");
   }
-  return (hint === "string" ? String : Number)(input);
+  return ("string" === r ? String : Number)(t);
 }
-function _toPropertyKey(arg) {
-  var key = _toPrimitive(arg, "string");
-  return typeof key === "symbol" ? key : String(key);
+function _toPropertyKey(t) {
+  var i = _toPrimitive(t, "string");
+  return "symbol" == typeof i ? i : i + "";
 }
 
 class AlgoliaError extends Error {
@@ -219,7 +237,7 @@ class ErrorWithStackTrace extends AlgoliaError {
 }
 class RetryError extends ErrorWithStackTrace {
   constructor(stackTrace) {
-    super('Unreachable hosts - your application id may be incorrect. If the error persists, contact support@algolia.com.', stackTrace, 'RetryError');
+    super('Unreachable hosts - your application id may be incorrect. If the error persists, please reach out to the Algolia Support team: https://alg.li/support.', stackTrace, 'RetryError');
   }
 }
 class ApiError extends ErrorWithStackTrace {
@@ -244,28 +262,16 @@ class DetailedApiError extends ApiError {
     this.error = error;
   }
 }
-
-function shuffle(array) {
-  const shuffledArray = array;
-  for (let c = array.length - 1; c > 0; c--) {
-    const b = Math.floor(Math.random() * (c + 1));
-    const a = array[c];
-    shuffledArray[c] = array[b];
-    shuffledArray[b] = a;
-  }
-  return shuffledArray;
-}
 function serializeUrl(host, path, queryParameters) {
   const queryParametersAsString = serializeQueryParameters(queryParameters);
-  let url = `${host.protocol}://${host.url}/${path.charAt(0) === '/' ? path.substr(1) : path}`;
+  let url = `${host.protocol}://${host.url}${host.port ? `:${host.port}` : ''}/${path.charAt(0) === '/' ? path.substring(1) : path}`;
   if (queryParametersAsString.length) {
     url += `?${queryParametersAsString}`;
   }
   return url;
 }
 function serializeQueryParameters(parameters) {
-  const isObjectOrArray = value => Object.prototype.toString.call(value) === '[object Object]' || Object.prototype.toString.call(value) === '[object Array]';
-  return Object.keys(parameters).map(key => `${key}=${encodeURIComponent(isObjectOrArray(parameters[key]) ? JSON.stringify(parameters[key]) : parameters[key])}`).join('&');
+  return Object.keys(parameters).filter(key => parameters[key] !== undefined).sort().map(key => `${key}=${encodeURIComponent(Object.prototype.toString.call(parameters[key]) === '[object Array]' ? parameters[key].join(',') : parameters[key]).replaceAll('+', '%20')}`).join('&');
 }
 function serializeData(request, requestOptions) {
   if (request.method === 'GET' || request.data === undefined && requestOptions.data === undefined) {
@@ -436,16 +442,13 @@ function createTransporter({
       if (host === undefined) {
         throw new RetryError(stackTraceWithoutCredentials(stackTrace));
       }
-      let responseTimeout = requestOptions.timeout;
-      if (responseTimeout === undefined) {
-        responseTimeout = isRead ? timeouts.read : timeouts.write;
-      }
+      let responseTimeout = isRead ? requestOptions.timeouts?.read || timeouts.read : requestOptions.timeouts?.write || timeouts.write;
       const payload = {
         data,
         headers,
         method: request.method,
         url: serializeUrl(host, request.path, queryParameters),
-        connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
+        connectTimeout: getTimeout(timeoutsCount, requestOptions.timeouts?.connect || timeouts.connect),
         responseTimeout: getTimeout(timeoutsCount, responseTimeout)
       };
       /**
@@ -673,42 +676,17 @@ function createXhrRequester() {
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
-const apiClientVersion = '1.0.0-alpha.9';
-function getDefaultHosts(appId) {
+const apiClientVersion = '1.0.0-beta.10';
+function getDefaultHosts() {
     return [
-        {
-            url: `${appId}-dsn.algolia.net`,
-            accept: 'read',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}.algolia.net`,
-            accept: 'write',
-            protocol: 'https',
-        },
-    ].concat(shuffle([
-        {
-            url: `${appId}-1.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}-2.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-        {
-            url: `${appId}-3.algolianet.com`,
-            accept: 'readWrite',
-            protocol: 'https',
-        },
-    ]));
+        { url: 'status.algolia.com', accept: 'readWrite', protocol: 'https' },
+    ];
 }
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }) {
     const auth = createAuth(appIdOption, apiKeyOption, authMode);
     const transporter = createTransporter({
-        hosts: getDefaultHosts(appIdOption),
+        hosts: getDefaultHosts(),
         ...options,
         algoliaAgent: getAlgoliaAgent({
             algoliaAgents,
@@ -758,17 +736,16 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
-         * @param del - The del object.
-         * @param del.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param del.parameters - Query parameters to apply to the current query.
+         * @param customDelete - The customDelete object.
+         * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customDelete.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        del({ path, parameters }, requestOptions) {
+        customDelete({ path, parameters }, requestOptions) {
             if (!path) {
-                throw new Error('Parameter `path` is required when calling `del`.');
+                throw new Error('Parameter `path` is required when calling `customDelete`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -782,17 +759,16 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
         /**
          * This method allow you to send requests to the Algolia REST API.
          *
-         * @summary Send requests to the Algolia REST API.
-         * @param get - The get object.
-         * @param get.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param get.parameters - Query parameters to apply to the current query.
+         * @param customGet - The customGet object.
+         * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customGet.parameters - Query parameters to apply to the current query.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        get({ path, parameters }, requestOptions) {
+        customGet({ path, parameters }, requestOptions) {
             if (!path) {
-                throw new Error('Parameter `path` is required when calling `get`.');
+                throw new Error('Parameter `path` is required when calling `customGet`.');
             }
-            const requestPath = '/1{path}'.replace('{path}', path);
+            const requestPath = '/{path}'.replace('{path}', path);
             const headers = {};
             const queryParameters = parameters ? parameters : {};
             const request = {
@@ -804,9 +780,58 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for selected clusters.
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customPost - The customPost object.
+         * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customPost.parameters - Query parameters to apply to the current query.
+         * @param customPost.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customPost({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPost`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'POST',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * This method allow you to send requests to the Algolia REST API.
+         *
+         * @param customPut - The customPut object.
+         * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
+         * @param customPut.parameters - Query parameters to apply to the current query.
+         * @param customPut.body - Parameters to send with the custom request.
+         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+         */
+        customPut({ path, parameters, body }, requestOptions) {
+            if (!path) {
+                throw new Error('Parameter `path` is required when calling `customPut`.');
+            }
+            const requestPath = '/{path}'.replace('{path}', path);
+            const headers = {};
+            const queryParameters = parameters ? parameters : {};
+            const request = {
+                method: 'PUT',
+                path: requestPath,
+                queryParameters,
+                headers,
+                data: body ? body : {},
+            };
+            return transporter.request(request, requestOptions);
+        },
+        /**
+         * Retrieves known incidents for the selected clusters.
          *
-         * @summary List incidents for selected clusters.
          * @param getClusterIncidents - The getClusterIncidents object.
          * @param getClusterIncidents.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -827,9 +852,8 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether a cluster is operational.
+         * Retrieves the status of selected clusters.
          *
-         * @summary List statuses of selected clusters.
          * @param getClusterStatus - The getClusterStatus object.
          * @param getClusterStatus.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -850,9 +874,8 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List known incidents for all clusters.
+         * Retrieves known incidents for all clusters.
          *
-         * @summary List incidents.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
         getIncidents(requestOptions) {
@@ -868,9 +891,8 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List the average times for indexing operations for selected clusters.
+         * Retrieves average times for indexing operations for selected clusters.
          *
-         * @summary Get indexing times.
          * @param getIndexingTime - The getIndexingTime object.
          * @param getIndexingTime.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -891,27 +913,8 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * List the servers belonging to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
+         * Retrieves the average latency for search requests for selected clusters.
          *
-         * @summary List servers.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        getInventory(requestOptions) {
-            const requestPath = '/1/inventory/servers';
-            const headers = {};
-            const queryParameters = {};
-            const request = {
-                method: 'GET',
-                path: requestPath,
-                queryParameters,
-                headers,
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * List the average latency for search requests for selected clusters.
-         *
-         * @summary Get search latency times.
          * @param getLatency - The getLatency object.
          * @param getLatency.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -932,11 +935,10 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report the aggregate value of a metric for a selected period of time.
+         * Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window.  Access to this API is available as part of the [Premium or Elevate plans](https://www.algolia.com/pricing). You must authenticate requests with the `x-algolia-application-id` and `x-algolia-api-key` headers (using the Monitoring API key).
          *
-         * @summary Get metrics for a given period.
          * @param getMetrics - The getMetrics object.
-         * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the response. To include all metrics, use `*` as the parameter.
+         * @param getMetrics.metric - Metric to report.  For more information about the individual metrics, see the description of the API response. To include all metrics, use `*`.
          * @param getMetrics.period - Period over which to aggregate the metrics:  - `minute`. Aggregate the last minute. 1 data point per 10 seconds. - `hour`. Aggregate the last hour. 1 data point per minute. - `day`. Aggregate the last day. 1 data point per 10 minutes. - `week`. Aggregate the last week. 1 data point per hour. - `month`. Aggregate the last month. 1 data point per day.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
@@ -963,7 +965,6 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
         /**
          * Test whether clusters are reachable or not.
          *
-         * @summary Test the reachability of clusters.
          * @param getReachability - The getReachability object.
          * @param getReachability.clusters - Subset of clusters, separated by comma.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -984,13 +985,12 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * Report whether clusters are operational.  The response depends on whether you authenticate your API request.  - With authentication, the response includes the status of the cluster assigned to your Algolia application.  - Without authentication, the response lists the statuses of all public Algolia clusters.
+         * Retrieves the servers that belong to clusters.  The response depends on whether you authenticate your API request:  - With authentication, the response lists the servers assigned to your Algolia application\'s cluster.  - Without authentication, the response lists the servers for all Algolia clusters.
          *
-         * @summary List cluster statuses.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        getStatus(requestOptions) {
-            const requestPath = '/1/status';
+        getServers(requestOptions) {
+            const requestPath = '/1/inventory/servers';
             const headers = {};
             const queryParameters = {};
             const request = {
@@ -1002,54 +1002,19 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
             return transporter.request(request, requestOptions);
         },
         /**
-         * This method allow you to send requests to the Algolia REST API.
-         *
-         * @summary Send requests to the Algolia REST API.
-         * @param post - The post object.
-         * @param post.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param post.parameters - Query parameters to apply to the current query.
-         * @param post.body - Parameters to send with the custom request.
-         * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
-         */
-        post({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `post`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
-            const headers = {};
-            const queryParameters = parameters ? parameters : {};
-            const request = {
-                method: 'POST',
-                path: requestPath,
-                queryParameters,
-                headers,
-                data: body ? body : {},
-            };
-            return transporter.request(request, requestOptions);
-        },
-        /**
-         * This method allow you to send requests to the Algolia REST API.
+         * Retrieves the status of all Algolia clusters and instances.
          *
-         * @summary Send requests to the Algolia REST API.
-         * @param put - The put object.
-         * @param put.path - Path of the endpoint, anything after \"/1\" must be specified.
-         * @param put.parameters - Query parameters to apply to the current query.
-         * @param put.body - Parameters to send with the custom request.
          * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
          */
-        put({ path, parameters, body }, requestOptions) {
-            if (!path) {
-                throw new Error('Parameter `path` is required when calling `put`.');
-            }
-            const requestPath = '/1{path}'.replace('{path}', path);
+        getStatus(requestOptions) {
+            const requestPath = '/1/status';
             const headers = {};
-            const queryParameters = parameters ? parameters : {};
+            const queryParameters = {};
             const request = {
-                method: 'PUT',
+                method: 'GET',
                 path: requestPath,
                 queryParameters,
                 headers,
-                data: body ? body : {},
             };
             return transporter.request(request, requestOptions);
         },
@@ -1057,6 +1022,7 @@ function createMonitoringClient({ appId: appIdOption, apiKey: apiKeyOption, auth
 }
 
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+// eslint-disable-next-line @typescript-eslint/explicit-function-return-type
 function monitoringClient(appId, apiKey, options) {
     if (!appId || typeof appId !== 'string') {
         throw new Error('`appId` is missing.');