@carto/api-client 0.5.30-alpha.b195e7f.118 → 0.5.30-alpha.e460f66.121

package/CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Unreleased
 
+- feat(fetchMap): Support line & polygon stroke dash styles (#297)
+
 ### 0.5.30
 
 - feat(widgetSources): support `featureIds` / `geometryType` request options to filter widget aggregations by a feature selection without relying on the synthetic `_carto_feature_id` column (#294)

package/build/api-client.cjs

@@ -146,6 +146,7 @@ __export(src_exports, {
   applySorting: () => applySorting,
   boundaryQuerySource: () => boundaryQuerySource,
   boundaryTableSource: () => boundaryTableSource,
+  buildAuthHeaders: () => buildAuthHeaders,
   buildBinaryFeatureFilter: () => buildBinaryFeatureFilter,
   buildPublicMapUrl: () => buildPublicMapUrl,
   buildStatsUrl: () => buildStatsUrl,
@@ -164,6 +165,7 @@ __export(src_exports, {
   filterFunctions: () => filterFunctions,
   geojsonFeatures: () => geojsonFeatures,
   getApplicableFilters: () => getApplicableFilters,
+  getAuthCredentials: () => getAuthCredentials,
   getClient: () => getClient,
   getColorAccessor: () => getColorAccessor,
   getColumnNameFromGeoColumn: () => getColumnNameFromGeoColumn,
@@ -173,6 +175,7 @@ __export(src_exports, {
   getIconUrlAccessor: () => getIconUrlAccessor,
   getLayerDescriptor: () => getLayerDescriptor,
   getLayerProps: () => getLayerProps,
+  getLineStyleAccessor: () => getLineStyleAccessor,
   getMaxMarkerSize: () => getMaxMarkerSize,
   getSizeAccessor: () => getSizeAccessor,
   getSorter: () => getSorter,
@@ -197,6 +200,7 @@ __export(src_exports, {
   rasterSource: () => rasterSource,
   removeFilter: () => removeFilter,
   requestWithParameters: () => requestWithParameters,
+  rewriteUrlForSessionMode: () => rewriteUrlForSessionMode,
   scaleAggregationResLevel: () => scaleAggregationResLevel,
   scatterPlot: () => scatterPlot,
   setClient: () => setClient,
@@ -5803,7 +5807,8 @@ var SchemaFieldType = /* @__PURE__ */ ((SchemaFieldType2) => {
   return SchemaFieldType2;
 })(SchemaFieldType || {});
 function isSpatialIndexFilter(spatialFilter) {
-  return Array.isArray(spatialFilter.indexes);
+  const filter = spatialFilter;
+  return Array.isArray(filter?.indexes) && ["h3", "h3int", "quadbin"].includes(filter?.type);
 }
 
 // src/utils.ts
@@ -5992,6 +5997,42 @@ init_cjs_shims();
 // src/api/index.ts
 init_cjs_shims();
 
+// src/api/auth.ts
+init_cjs_shims();
+function buildAuthHeaders(options) {
+  if (options.authMode === "session") {
+    if (options.accessToken) {
+      throw new Error(
+        `accessToken must not be provided with authMode: 'session' \u2014 authentication is delegated to the server behind apiBaseUrl`
+      );
+    }
+    return {};
+  }
+  if (!options.accessToken) {
+    throw new Error(
+      `accessToken is required (or pass authMode: 'session' to authenticate via a same-origin session instead)`
+    );
+  }
+  return { Authorization: `Bearer ${options.accessToken}` };
+}
+function getAuthCredentials(authMode) {
+  return authMode === "session" ? "same-origin" : void 0;
+}
+function rewriteUrlForSessionMode(url, apiBaseUrl) {
+  let origin;
+  try {
+    const parsed = new URL(url);
+    if (parsed.protocol !== "http:" && parsed.protocol !== "https:") {
+      return url;
+    }
+    origin = parsed.origin;
+  } catch {
+    return url;
+  }
+  const base = apiBaseUrl.replace(/\/+$/, "");
+  return base + url.slice(origin.length);
+}
+
 // src/api/carto-api-error.ts
 init_cjs_shims();
 var CartoAPIError = class extends Error {
@@ -6113,7 +6154,8 @@ async function requestWithParameters({
   errorContext,
   maxLengthURL = DEFAULT_MAX_LENGTH_URL,
   localCache,
-  signal
+  signal,
+  credentials
 }) {
   parameters = {
     v: V3_MINOR_VERSION,
@@ -6137,8 +6179,9 @@ async function requestWithParameters({
     method: "POST",
     body: JSON.stringify(parameters),
     headers,
-    signal
-  }) : fetch(url, { headers, signal });
+    signal,
+    ...credentials && { credentials }
+  }) : fetch(url, { headers, signal, ...credentials && { credentials } });
   let response;
   let responseJson;
   const jsonPromise = fetchPromise.then((_response) => {
@@ -6184,8 +6227,19 @@ function createCacheKey(baseUrl, parameters, headers) {
     headers: headerEntries
   });
 }
+var RELATIVE_ORIGIN = "https://relative.invalid";
+function parseBaseUrl(baseUrlString) {
+  const isRelative = baseUrlString.startsWith("/") && !baseUrlString.startsWith("//");
+  return {
+    url: new URL(baseUrlString, isRelative ? RELATIVE_ORIGIN : void 0),
+    isRelative
+  };
+}
+function serializeBaseUrl(url, isRelative) {
+  return isRelative ? `${url.pathname}${url.search}` : url.toString();
+}
 function createURLWithParameters(baseUrlString, parameters) {
-  const baseUrl = new URL(baseUrlString);
+  const { url: baseUrl, isRelative } = parseBaseUrl(baseUrlString);
   for (const [key, value] of Object.entries(parameters)) {
     if (isPureObject(value) || Array.isArray(value)) {
       baseUrl.searchParams.set(key, JSON.stringify(value));
@@ -6198,16 +6252,16 @@ function createURLWithParameters(baseUrlString, parameters) {
       }
     }
   }
-  return baseUrl.toString();
+  return serializeBaseUrl(baseUrl, isRelative);
 }
 function excludeURLParameters(baseUrlString, parameters) {
-  const baseUrl = new URL(baseUrlString);
+  const { url: baseUrl, isRelative } = parseBaseUrl(baseUrlString);
   for (const param of parameters) {
     if (baseUrl.searchParams.has(param)) {
       baseUrl.searchParams.delete(param);
     }
   }
-  return baseUrl.toString();
+  return serializeBaseUrl(baseUrl, isRelative);
 }
 function clearDefaultRequestCache() {
   DEFAULT_REQUEST_CACHE.clear();
@@ -6235,10 +6289,12 @@ async function baseSource(endpoint, options, urlParameters) {
   }
   const baseUrl = buildSourceUrl(mergedOptions);
   const { clientId, maxLengthURL, localCache } = mergedOptions;
+  const sessionMode = options.authMode === "session";
   const headers = {
-    Authorization: `Bearer ${options.accessToken}`,
+    ...buildAuthHeaders(options),
     ...options.headers
   };
+  const credentials = getAuthCredentials(options.authMode);
   const parameters = { client: clientId, ...options.tags, ...urlParameters };
   const errorContext = {
     requestType: "Map instantiation",
@@ -6252,15 +6308,19 @@ async function baseSource(endpoint, options, urlParameters) {
     headers,
     errorContext,
     maxLengthURL,
-    localCache
+    localCache,
+    credentials
   });
-  const dataUrl = tilejson.url[0];
+  let dataUrl = tilejson.url[0];
   if (cache) {
     cache.value = parseInt(
       new URL(dataUrl).searchParams.get("cache") || "",
       10
     );
   }
+  if (sessionMode) {
+    dataUrl = rewriteUrlForSessionMode(dataUrl, mergedOptions.apiBaseUrl);
+  }
   errorContext.requestType = "Map data";
   const json = await requestWithParameters({
     baseUrl: dataUrl,
@@ -6268,9 +6328,14 @@ async function baseSource(endpoint, options, urlParameters) {
     headers,
     errorContext,
     maxLengthURL,
-    localCache
+    localCache,
+    credentials
   });
-  if (accessToken) {
+  if (sessionMode) {
+    json.tiles = json.tiles?.map(
+      (template) => rewriteUrlForSessionMode(template, mergedOptions.apiBaseUrl)
+    );
+  } else if (accessToken) {
     json.accessToken = accessToken;
   }
   if (schema) {
@@ -6393,6 +6458,7 @@ function dealWithApiError({
 async function makeCall({
   url,
   accessToken,
+  authMode,
   opts
 }) {
   let response;
@@ -6401,10 +6467,13 @@ async function makeCall({
   try {
     response = await fetch(url.toString(), {
       headers: {
-        Authorization: `Bearer ${accessToken}`,
+        ...buildAuthHeaders({ accessToken, authMode }),
         ...isPost && { "Content-Type": "application/json" },
         ...opts.headers
       },
+      ...getAuthCredentials(authMode) && {
+        credentials: getAuthCredentials(authMode)
+      },
       ...isPost && {
         method: opts?.method,
         body: opts?.body
@@ -6448,9 +6517,8 @@ function executeModel(props) {
     )}`
   );
   const { model, source, params, opts } = props;
-  const { type, apiVersion, apiBaseUrl, accessToken, connectionName, clientId } = source;
+  const { type, apiVersion, apiBaseUrl, connectionName, clientId } = source;
   assert2(apiBaseUrl, "executeModel: missing apiBaseUrl");
-  assert2(accessToken, "executeModel: missing accessToken");
   assert2(apiVersion === V3, "executeModel: SQL Model API requires CARTO 3+");
   assert2(type !== "tileset", "executeModel: Tilesets not supported");
   let url = `${apiBaseUrl}/v3/sql/${connectionName}/model/${model}`;
@@ -6489,6 +6557,7 @@ function executeModel(props) {
   return makeCall({
     url,
     accessToken: source.accessToken,
+    authMode: source.authMode,
     opts: {
       ...opts,
       method: isGet ? "GET" : "POST",
@@ -6615,6 +6684,7 @@ var WidgetRemoteSource = class extends WidgetSource {
       apiBaseUrl: props.apiBaseUrl,
       clientId: props.clientId,
       accessToken: props.accessToken,
+      authMode: props.authMode,
       connectionName: props.connectionName,
       filters: getApplicableFilters(filterOwner, filters || props.filters),
       filtersLogicalOperator: props.filtersLogicalOperator,
@@ -6944,7 +7014,7 @@ var WidgetRemoteSource = class extends WidgetSource {
       url = `${apiBaseUrl}/${apiVersion}/stats/${connectionName}/${data}/${spatialDataColumn}`;
     }
     const headers = {
-      Authorization: `Bearer ${this.props.accessToken}`,
+      ...buildAuthHeaders(this.props),
       ...this.props.headers
     };
     const errorContext = {
@@ -6957,7 +7027,8 @@ var WidgetRemoteSource = class extends WidgetSource {
       headers,
       signal,
       errorContext,
-      parameters
+      parameters,
+      credentials: getAuthCredentials(this.props.authMode)
     }).then(({ extent: { xmin, ymin, xmax, ymax } }) => ({
       bbox: [xmin, ymin, xmax, ymax]
     }));
@@ -8739,7 +8810,7 @@ var query = async function(options) {
   }
   const baseUrl = buildQueryUrl({ apiBaseUrl, connectionName });
   const headers = {
-    Authorization: `Bearer ${options.accessToken}`,
+    ...buildAuthHeaders(options),
     ...options.headers
   };
   const parameters = {
@@ -8761,7 +8832,8 @@ var query = async function(options) {
     errorContext,
     maxLengthURL,
     localCache,
-    signal: options.signal
+    signal: options.signal,
+    credentials: getAuthCredentials(options.authMode)
   });
 };
 
@@ -10078,6 +10150,19 @@ function getIconUrlAccessor(field, range, {
   };
   return normalizeAccessor(accessor, data);
 }
+function getLineStyleAccessor(field, range, data) {
+  const fallback = range.othersDashArray ?? [0, 0];
+  const mapping = {};
+  for (const { value, dashArray } of range.dashArrayMap) {
+    mapping[value] = dashArray;
+  }
+  const accessor = (properties) => mapping[properties[field.name]] ?? fallback;
+  return {
+    accessor: normalizeAccessor(accessor, data),
+    domain: range.dashArrayMap.map(({ value }) => value),
+    range: range.dashArrayMap.map(({ dashArray }) => dashArray)
+  };
+}
 function getMaxMarkerSize(visConfig, visualChannels) {
   const { radiusRange, radius, sizeMaxPixels } = visConfig;
   const { radiusField, sizeField } = visualChannels;
@@ -10791,6 +10876,10 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
   const result = {};
   const updateTriggers = {};
   const scales = {};
+  const isVectorTile = layerType === "mvt" || layerType === "tileset";
+  const geometry = data.tilestats?.layers?.[0]?.geometry;
+  const isLine = geometry === "Line" || geometry === "LineString" || geometry === "MultiLineString";
+  const isPolygon = geometry === "Polygon" || geometry === "MultiPolygon";
   {
     const { colorField, colorScale } = visualChannels;
     const { colorRange } = visConfig;
@@ -10951,6 +11040,43 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
       };
     }
   }
+  {
+    const strokeVisible = isLine || isPolygon && Boolean(visConfig.stroked);
+    if (isVectorTile && strokeVisible) {
+      const { lineStyleField, lineStyleScale } = visualChannels;
+      const { lineStyleRange } = visConfig;
+      if (visConfig.lineStyle && visConfig.lineStyle !== "solid") {
+        if (visConfig.lineStyle === "dotted") {
+          result.lineCapRounded = true;
+        }
+        result.lineStyle = visConfig.lineStyle;
+        if (visConfig.dashArray) {
+          result.dashArray = visConfig.dashArray;
+          result.getDashArray = visConfig.dashArray;
+        }
+      }
+      if (lineStyleField && lineStyleScale && lineStyleRange) {
+        const { accessor, ...scaleProps } = getLineStyleAccessor(
+          lineStyleField,
+          lineStyleRange,
+          data
+        );
+        result.getDashArray = accessor;
+        scales.lineStyle = updateTriggers.getDashArray = {
+          field: lineStyleField,
+          type: lineStyleScale,
+          ...scaleProps
+        };
+        const dashArrays = [
+          ...lineStyleRange.dashArrayMap.map(({ dashArray }) => dashArray),
+          ...lineStyleRange.othersDashArray ? [lineStyleRange.othersDashArray] : []
+        ];
+        if (dashArrays.some(([dash]) => dash === 0)) {
+          result.lineCapRounded = true;
+        }
+      }
+    }
+  }
   {
     const { heightField, heightScale } = visualChannels;
     const { enable3d, heightRange } = visConfig;
@@ -11079,9 +11205,7 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
     } = secondaryLabel || {};
     result.getText = mainLabel.field && getTextAccessor(mainLabel.field, data);
     const getSecondaryText = secondaryField && getTextAccessor(secondaryField, data);
-    const geometry = data.tilestats?.layers?.[0]?.geometry;
-    const isLineOrPolygon = geometry === "Polygon" || geometry === "MultiPolygon" || geometry === "Line" || geometry === "LineString" || geometry === "MultiLineString";
-    if (isLineOrPolygon && (layerType === "tileset" || layerType === "mvt")) {
+    if ((isLine || isPolygon) && isVectorTile) {
       const uniqueIdProperty = visConfig.textLabelUniqueIdField;
       result.autoLabels = uniqueIdProperty ? { uniqueIdProperty } : true;
       result.pointType = "text";
@@ -11118,6 +11242,9 @@ function createChannelProps(id, layerType, config2, visualChannels, data, datase
   };
 }
 function createLoadOptions(accessToken) {
+  if (!accessToken) {
+    return { loadOptions: { fetch: { credentials: "same-origin" } } };
+  }
   return {
     loadOptions: { fetch: { headers: { Authorization: `Bearer ${accessToken}` } } }
   };
@@ -11820,6 +11947,7 @@ function hashBuckets(initialCount) {
   applySorting,
   boundaryQuerySource,
   boundaryTableSource,
+  buildAuthHeaders,
   buildBinaryFeatureFilter,
   buildPublicMapUrl,
   buildStatsUrl,
@@ -11838,6 +11966,7 @@ function hashBuckets(initialCount) {
   filterFunctions,
   geojsonFeatures,
   getApplicableFilters,
+  getAuthCredentials,
   getClient,
   getColorAccessor,
   getColumnNameFromGeoColumn,
@@ -11847,6 +11976,7 @@ function hashBuckets(initialCount) {
   getIconUrlAccessor,
   getLayerDescriptor,
   getLayerProps,
+  getLineStyleAccessor,
   getMaxMarkerSize,
   getSizeAccessor,
   getSorter,
@@ -11871,6 +12001,7 @@ function hashBuckets(initialCount) {
   rasterSource,
   removeFilter,
   requestWithParameters,
+  rewriteUrlForSessionMode,
   scaleAggregationResLevel,
   scatterPlot,
   setClient,