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

package/build/sources/types.d.ts

@@ -38,6 +38,24 @@ export type SourceOptionalOptions = {
      * @default {@link DEFAULT_MAX_LENGTH_URL}
      */
     maxLengthURL?: number;
+    /**
+     * By default, local in-memory caching is enabled.
+     */
+    localCache?: LocalCacheOptions;
+};
+export type LocalCacheOptions = {
+    /**
+     * Map that stores requests and their responses.
+     */
+    cache?: Map<string, Promise<unknown>>;
+    /**
+     * Cache control
+     *  * `no-cache`: If present, the source will always fetch from original source.
+     *  * `no-store`: If present, source will not store result in cache (for later reuse).
+     *
+     * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#directives
+     */
+    cacheControl?: ('no-cache' | 'no-store')[];
 };
 export type SourceOptions = SourceRequiredOptions & Partial<SourceOptionalOptions>;
 export type AggregationOptions = {
@@ -166,16 +184,42 @@ export interface Tilejson {
     attribution: string;
     scheme: string;
     tiles: string[];
-    properties_tiles: string[];
-    minresolution: number;
-    maxresolution: number;
     minzoom: number;
     maxzoom: number;
-    bounds: [number, number, number, number];
-    center: [number, number, number];
+    bounds: [left: number, bottom: number, right: number, top: number];
+    center: [longitute: number, latitude: number, zoom: number];
     vector_layers: VectorLayer[];
+    minresolution: number;
+    maxresolution: number;
+    properties_tiles: string[];
     tilestats: Tilestats;
     tileResolution?: TileResolution;
+    /**
+     * Resolution of data in spatial-index dataset (e.g. H3, Quadbin).
+     *
+     * @internal
+     */
+    dataresolution?: number;
+    /**
+     * Array of ratios of dropped features per zoom level.
+     *
+     * Example: `[0,0,0.5]` - means that 50% of features are dropped at zoom 2 and bigger.
+     *
+     * @internal
+     */
+    fraction_dropped_per_zoom?: number[];
+    /**
+     * Names of bands - rasters only.
+     *
+     * @internal
+     */
+    raster_bands?: string[];
+    /**
+     * Raster metadata - rasters only.
+     *
+     * @internal
+     */
+    raster_metadata?: RasterMetadata;
 }
 export interface Tilestats {
     layerCount: number;
@@ -196,7 +240,99 @@ export interface VectorLayer {
     minzoom: number;
     maxzoom: number;
     fields: Record<string, string>;
+    geometry_type?: string;
 }
+export type RasterMetadataBandStats = {
+    approximated_stats?: boolean;
+    min: number;
+    max: number;
+    mean: number;
+    stddev: number;
+    sum: number;
+    sum_squares: number;
+    count: number;
+    /**
+     * Quantiles by number of buckets.
+     *
+     * Example:
+     * ```ts
+     *   {
+     *     // for 3 buckets, first 1/3 of items lies in range [min, 20], second 1/3 is in [20, 40], and last 1/3 is in [40, max]
+     *     3: [20, 40],
+     *     4: [20, 30, 50], for 4 buckets ...
+     *   }
+     * ```
+     */
+    quantiles?: Record<number, number[]>;
+    /**
+     * Top values by number of values.
+     *
+     * Key of dictionary is value, value is count.
+     * Key order is random.
+     *
+     * Example:
+     * ```
+     *  {
+     *    3: 5, // means there are 5 pixels with value 3
+     *    11: 222,
+     *    12: 333, // means that 12 is most common value with count 333
+     *    ...      // (assuming 333 was largest value in dict)
+     *   }
+     * ```
+     */
+    top_values?: Record<number, number>;
+    /**
+     * Raster loader version.
+     */
+    version?: string;
+};
+export declare enum RasterBandColorinterp {
+    Gray = "gray",
+    Red = "red",
+    Green = "green",
+    Blue = "blue",
+    Alpha = "alpha",
+    Palette = "palette"
+}
+export type RasterMetadataBand = {
+    type: string;
+    name: string;
+    stats: RasterMetadataBandStats;
+    /**
+     * Known values:
+     *  * `palette`: use unique value and `colortable` ad default mapping
+     *  * `red`, `green`, `blue`: use the band as color channel
+     *  * `gray`: use the band as grayscale
+     */
+    colorinterp?: string | RasterBandColorinterp;
+    /**
+     * Default color mapping for unique values (or if coloprinterp is `palette`)
+     */
+    colortable?: Record<string, number[]>;
+    /**
+     * No value representation.
+     * Observed values:
+     *   * `'nan'` for `NaN`
+     *   * `number`: both as string as number, so parsing is needed
+     */
+    nodata: string | number;
+};
+export type RasterMetadata = {
+    block_resolution: number;
+    minresolution: number;
+    maxresolution: number;
+    nodata: number | string;
+    bands: RasterMetadataBand[];
+    bounds: [left: number, bottom: number, right: number, top: number];
+    center: [longitute: number, latitude: number, zoom: number];
+    width: number;
+    height: number;
+    block_width: number;
+    block_height: number;
+    num_blocks: number;
+    num_pixels: number;
+    pixel_resolution: number;
+};
 export type TilejsonResult = Tilejson & {
     accessToken: string;
 };

package/package.json

@@ -4,7 +4,7 @@
   "repository": "github:CartoDB/carto-api-client",
   "author": "Don McCurdy <donmccurdy@carto.com>",
   "packageManager": "yarn@4.3.1",
-  "version": "0.4.0",
+  "version": "0.4.1-alpha.1",
   "license": "MIT",
   "publishConfig": {
     "access": "public",

package/src/api/query.ts

@@ -23,6 +23,7 @@ export const query = async function (
     apiBaseUrl = SOURCE_DEFAULTS.apiBaseUrl,
     clientId = SOURCE_DEFAULTS.clientId,
     maxLengthURL = SOURCE_DEFAULTS.maxLengthURL,
+    localCache,
     connectionName,
     sqlQuery,
     queryParameters,
@@ -52,5 +53,6 @@ export const query = async function (
     headers,
     errorContext,
     maxLengthURL,
+    localCache,
   });
 };

package/src/api/request-with-parameters.ts

@@ -7,13 +7,14 @@ import {CartoAPIError, APIErrorContext} from './carto-api-error';
 import {V3_MINOR_VERSION} from '../constants-internal';
 import {DEFAULT_MAX_LENGTH_URL} from '../constants-internal';
 import {getClient} from '../client';
+import {LocalCacheOptions} from '../sources/types';
 
 const DEFAULT_HEADERS = {
   Accept: 'application/json',
   'Content-Type': 'application/json',
 };
 
-const REQUEST_CACHE = new Map<string, Promise<unknown>>();
+const DEFAULT_REQUEST_CACHE = new Map<string, Promise<unknown>>();
 
 export async function requestWithParameters<T = any>({
   baseUrl,
@@ -21,12 +22,14 @@ export async function requestWithParameters<T = any>({
   headers: customHeaders = {},
   errorContext,
   maxLengthURL = DEFAULT_MAX_LENGTH_URL,
+  localCache,
 }: {
   baseUrl: string;
   parameters?: Record<string, unknown>;
   headers?: Record<string, string>;
   errorContext: APIErrorContext;
   maxLengthURL?: number;
+  localCache?: LocalCacheOptions;
 }): Promise<T> {
   // Parameters added to all requests issued with `requestWithParameters()`.
   // These parameters override parameters already in the base URL, but not
@@ -41,7 +44,14 @@ export async function requestWithParameters<T = any>({
 
   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 REQUEST_CACHE.get(key) as Promise<T>;
   }
 
@@ -73,14 +83,34 @@ export async function requestWithParameters<T = any>({
       return json;
     })
     .catch((error: 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 jsonPromise;
 }
 
+function getCacheSettings(localCache: LocalCacheOptions | undefined) {
+  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: string,
   parameters: Record<string, unknown>,

package/src/sources/base-source.ts

@@ -45,7 +45,7 @@ export async function baseSource<UrlParameters extends Record<string, unknown>>(
     }
   }
   const baseUrl = buildSourceUrl(mergedOptions);
-  const {clientId, maxLengthURL, format} = mergedOptions;
+  const {clientId, maxLengthURL, format, localCache} = mergedOptions;
   const headers = {
     Authorization: `Bearer ${options.accessToken}`,
     ...options.headers,
@@ -65,6 +65,7 @@ export async function baseSource<UrlParameters extends Record<string, unknown>>(
       headers,
       errorContext,
       maxLengthURL,
+      localCache,
     });
 
   const dataUrl = mapInstantiation[format].url[0];
@@ -82,6 +83,7 @@ export async function baseSource<UrlParameters extends Record<string, unknown>>(
       headers,
       errorContext,
       maxLengthURL,
+      localCache,
     });
     if (accessToken) {
       json.accessToken = accessToken;
@@ -94,5 +96,6 @@ export async function baseSource<UrlParameters extends Record<string, unknown>>(
     headers,
     errorContext,
     maxLengthURL,
+    localCache,
   });
 }

package/src/sources/index.ts

@@ -4,6 +4,11 @@
 
 export {SOURCE_DEFAULTS} from './base-source';
 export type {
+  VectorLayer,
+  RasterMetadataBandStats,
+  RasterBandColorinterp,
+  RasterMetadataBand,
+  RasterMetadata,
   TilejsonResult,
   GeojsonResult,
   JsonResult,

package/src/sources/types.ts

@@ -47,6 +47,27 @@ export type SourceOptionalOptions = {
    * @default {@link DEFAULT_MAX_LENGTH_URL}
    */
   maxLengthURL?: number;
+
+  /**
+   * By default, local in-memory caching is enabled.
+   */
+  localCache?: LocalCacheOptions;
+};
+
+export type LocalCacheOptions = {
+  /**
+   * Map that stores requests and their responses.
+   */
+  cache?: Map<string, Promise<unknown>>;
+
+  /**
+   * Cache control
+   *  * `no-cache`: If present, the source will always fetch from original source.
+   *  * `no-store`: If present, source will not store result in cache (for later reuse).
+   *
+   * See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#directives
+   */
+  cacheControl?: ('no-cache' | 'no-store')[];
 };
 
 export type SourceOptions = SourceRequiredOptions &
@@ -191,16 +212,51 @@ export interface Tilejson {
   attribution: string;
   scheme: string;
   tiles: string[];
-  properties_tiles: string[];
-  minresolution: number;
-  maxresolution: number;
   minzoom: number;
   maxzoom: number;
-  bounds: [number, number, number, number];
-  center: [number, number, number];
+  bounds: [left: number, bottom: number, right: number, top: number];
+  center: [longitute: number, latitude: number, zoom: number];
   vector_layers: VectorLayer[];
+
+  //
+  // Carto additions over standard Tilejson properties
+  //
+
+  minresolution: number;
+  maxresolution: number;
+  properties_tiles: string[];
   tilestats: Tilestats;
   tileResolution?: TileResolution;
+
+  /**
+   * Resolution of data in spatial-index dataset (e.g. H3, Quadbin).
+   *
+   * @internal
+   */
+  dataresolution?: number;
+
+  /**
+   * Array of ratios of dropped features per zoom level.
+   *
+   * Example: `[0,0,0.5]` - means that 50% of features are dropped at zoom 2 and bigger.
+   *
+   * @internal
+   */
+  fraction_dropped_per_zoom?: number[];
+
+  /**
+   * Names of bands - rasters only.
+   *
+   * @internal
+   */
+  raster_bands?: string[];
+
+  /**
+   * Raster metadata - rasters only.
+   *
+   * @internal
+   */
+  raster_metadata?: RasterMetadata;
 }
 
 export interface Tilestats {
@@ -221,12 +277,116 @@ export interface Attribute {
 }
 
 export interface VectorLayer {
+  // tilejson standard
   id: string;
   minzoom: number;
   maxzoom: number;
   fields: Record<string, string>;
+
+  // Carto additions over standard Tilejson properties
+  geometry_type?: string;
+}
+
+export type RasterMetadataBandStats = {
+  approximated_stats?: boolean;
+  min: number;
+  max: number;
+  mean: number;
+  stddev: number;
+  sum: number;
+  sum_squares: number;
+  count: number;
+
+  /**
+   * Quantiles by number of buckets.
+   *
+   * Example:
+   * ```ts
+   *   {
+   *     // for 3 buckets, first 1/3 of items lies in range [min, 20], second 1/3 is in [20, 40], and last 1/3 is in [40, max]
+   *     3: [20, 40],
+   *     4: [20, 30, 50], for 4 buckets ...
+   *   }
+   * ```
+   */
+  quantiles?: Record<number, number[]>;
+
+  /**
+   * Top values by number of values.
+   *
+   * Key of dictionary is value, value is count.
+   * Key order is random.
+   *
+   * Example:
+   * ```
+   *  {
+   *    3: 5, // means there are 5 pixels with value 3
+   *    11: 222,
+   *    12: 333, // means that 12 is most common value with count 333
+   *    ...      // (assuming 333 was largest value in dict)
+   *   }
+   * ```
+   */
+  top_values?: Record<number, number>;
+
+  /**
+   * Raster loader version.
+   */
+  version?: string;
+};
+
+export enum RasterBandColorinterp {
+  Gray = 'gray',
+  Red = 'red',
+  Green = 'green',
+  Blue = 'blue',
+  Alpha = 'alpha',
+  Palette = 'palette',
 }
 
+export type RasterMetadataBand = {
+  type: string;
+  name: string;
+  stats: RasterMetadataBandStats;
+  /**
+   * Known values:
+   *  * `palette`: use unique value and `colortable` ad default mapping
+   *  * `red`, `green`, `blue`: use the band as color channel
+   *  * `gray`: use the band as grayscale
+   */
+  colorinterp?: string | RasterBandColorinterp; // use RasterBandColorinterp, but it's external value, so let's use string
+
+  /**
+   * Default color mapping for unique values (or if coloprinterp is `palette`)
+   */
+  colortable?: Record<string, number[]>;
+
+  /**
+   * No value representation.
+   * Observed values:
+   *   * `'nan'` for `NaN`
+   *   * `number`: both as string as number, so parsing is needed
+   */
+  nodata: string | number; // 255, '0', 'nan'
+};
+
+export type RasterMetadata = {
+  block_resolution: number;
+  minresolution: number;
+  maxresolution: number;
+  nodata: number | string;
+  bands: RasterMetadataBand[];
+  bounds: [left: number, bottom: number, right: number, top: number];
+  center: [longitute: number, latitude: number, zoom: number];
+  width: number;
+  height: number;
+  block_width: number;
+  block_height: number;
+  num_blocks: number;
+  num_pixels: number;
+  pixel_resolution: number;
+};
+
 export type TilejsonResult = Tilejson & {accessToken: string};
 export type GeojsonResult = {type: 'FeatureCollection'; features: Feature[]};
 export type JsonResult = any[];