@carto/api-client 0.4.0 → 0.4.1-alpha.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## Not released
+
+- add cache control mechanism for sources and query APIs
+
 ## 0.4
 
 ### 0.4.0

package/build/api/request-with-parameters.d.ts

@@ -1,8 +1,10 @@
 import { APIErrorContext } from './carto-api-error';
-export declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, }: {
+import { LocalCacheOptions } from '../sources/types';
+export declare function requestWithParameters<T = any>({ baseUrl, parameters, headers: customHeaders, errorContext, maxLengthURL, localCache, }: {
     baseUrl: string;
     parameters?: Record<string, unknown>;
     headers?: Record<string, string>;
     errorContext: APIErrorContext;
     maxLengthURL?: number;
+    localCache?: LocalCacheOptions;
 }): Promise<T>;

package/build/api-client.cjs

@@ -1148,7 +1148,8 @@ const requestWithParameters = function (_ref) {
     parameters = {},
     headers: customHeaders = {},
     errorContext,
-    maxLengthURL = DEFAULT_MAX_LENGTH_URL
+    maxLengthURL = DEFAULT_MAX_LENGTH_URL,
+    localCache
   } = _ref;
   try {
     // Parameters added to all requests issued with `requestWithParameters()`.
@@ -1164,7 +1165,12 @@ const requestWithParameters = function (_ref) {
     };
     baseUrl = excludeURLParameters(baseUrl, Object.keys(parameters));
     const key = createCacheKey(baseUrl, parameters, customHeaders);
-    if (REQUEST_CACHE.has(key)) {
+    const {
+      cache: REQUEST_CACHE,
+      canReadCache,
+      canStoreInCache
+    } = getCacheSettings(localCache);
+    if (canReadCache && REQUEST_CACHE.has(key)) {
       return Promise.resolve(REQUEST_CACHE.get(key));
     }
     const url = createURLWithParameters(baseUrl, parameters);
@@ -1192,10 +1198,14 @@ const requestWithParameters = function (_ref) {
       }
       return json;
     }).catch(error => {
-      REQUEST_CACHE.delete(key);
+      if (canStoreInCache) {
+        REQUEST_CACHE.delete(key);
+      }
       throw new CartoAPIError(error, errorContext, response, responseJson);
     });
-    REQUEST_CACHE.set(key, jsonPromise);
+    if (canStoreInCache) {
+      REQUEST_CACHE.set(key, jsonPromise);
+    }
     return Promise.resolve(jsonPromise);
   } catch (e) {
     return Promise.reject(e);
@@ -1205,7 +1215,17 @@ const DEFAULT_HEADERS = {
   Accept: 'application/json',
   'Content-Type': 'application/json'
 };
-const REQUEST_CACHE = new Map();
+const DEFAULT_REQUEST_CACHE = new Map();
+function getCacheSettings(localCache) {
+  const canReadCache = localCache?.cacheControl?.includes('no-cache') ? false : true;
+  const canStoreInCache = localCache?.cacheControl?.includes('no-store') ? false : true;
+  const cache = localCache?.cache || DEFAULT_REQUEST_CACHE;
+  return {
+    cache,
+    canReadCache,
+    canStoreInCache
+  };
+}
 function createCacheKey(baseUrl, parameters, headers) {
   const parameterEntries = Object.entries(parameters).sort((_ref2, _ref3) => {
     let [a] = _ref2;
@@ -1276,7 +1296,8 @@ const baseSource = function (endpoint, options, urlParameters) {
     const {
       clientId,
       maxLengthURL,
-      format
+      format,
+      localCache
     } = mergedOptions;
     const headers = {
       Authorization: `Bearer ${options.accessToken}`,
@@ -1297,7 +1318,8 @@ const baseSource = function (endpoint, options, urlParameters) {
       parameters,
       headers,
       errorContext,
-      maxLengthURL
+      maxLengthURL,
+      localCache
     })).then(function (mapInstantiation) {
       let _exit;
       function _temp2(_result) {
@@ -1305,7 +1327,8 @@ const baseSource = function (endpoint, options, urlParameters) {
           baseUrl: dataUrl,
           headers,
           errorContext,
-          maxLengthURL
+          maxLengthURL,
+          localCache
         }));
       }
       const dataUrl = mapInstantiation[format].url[0];
@@ -1319,7 +1342,8 @@ const baseSource = function (endpoint, options, urlParameters) {
             baseUrl: dataUrl,
             headers,
             errorContext,
-            maxLengthURL
+            maxLengthURL,
+            localCache
           })).then(function (json) {
             if (accessToken) {
               json.accessToken = accessToken;
@@ -1666,6 +1690,7 @@ const query = function (options) {
       apiBaseUrl = SOURCE_DEFAULTS.apiBaseUrl,
       clientId = SOURCE_DEFAULTS.clientId,
       maxLengthURL = SOURCE_DEFAULTS.maxLengthURL,
+      localCache,
       connectionName,
       sqlQuery,
       queryParameters
@@ -1699,7 +1724,8 @@ const query = function (options) {
       parameters,
       headers,
       errorContext,
-      maxLengthURL
+      maxLengthURL,
+      localCache
     }));
   } catch (e) {
     return Promise.reject(e);