@carto/api-client 0.5.2-alpha.1 → 0.5.2-alpha.2

package/build/api-client.d.cts

@@ -219,6 +219,32 @@ type PositionalQueryParameter = QueryParameterValue[];
 /** @privateRemarks Source: @deck.gl/carto */
 type QueryParameters = NamedQueryParameter | PositionalQueryParameter;
 
+/******************************************************************************
+ * MAP INSTANTIATION
+ */
+/**
+ * @privateRemarks Source: @deck.gl/carto
+ * @internal
+ */
+declare enum SchemaFieldType {
+    Number = "number",
+    Bigint = "bigint",
+    String = "string",
+    Geometry = "geometry",
+    Timestamp = "timestamp",
+    Object = "object",
+    Boolean = "boolean",
+    Variant = "variant",
+    Unknown = "unknown"
+}
+/**
+ * @privateRemarks Source: @deck.gl/carto
+ * @internal
+ */
+interface SchemaField {
+    name: string;
+    type: SchemaFieldType;
+}
 /******************************************************************************
  * LOCAL CALCULATIONS
  */
@@ -630,6 +656,7 @@ type RasterMetadata = {
 };
 type TilejsonResult = Tilejson & {
     accessToken: string;
+    schema: SchemaField[];
 };
 type QueryResult = {
     meta: {
@@ -697,7 +724,7 @@ declare function calculateClusterRadius(properties: {
     max: number;
 }>, radiusRange: [number, number], column: string): number;
 /** @privateRemarks Source: Builder */
-declare function getDefaultAggregationExpColumnAliasForLayerType(layerType: LayerType, provider: ProviderType, columns: string[]): string;
+declare function getDefaultAggregationExpColumnAliasForLayerType(layerType: LayerType, provider: ProviderType, schema: SchemaField[]): string;
 /** @privateRemarks Source: Builder */
 declare function calculateClusterTextFontSize(radius: number): number;
 

package/build/api-client.d.ts

@@ -219,6 +219,32 @@ type PositionalQueryParameter = QueryParameterValue[];
 /** @privateRemarks Source: @deck.gl/carto */
 type QueryParameters = NamedQueryParameter | PositionalQueryParameter;
 
+/******************************************************************************
+ * MAP INSTANTIATION
+ */
+/**
+ * @privateRemarks Source: @deck.gl/carto
+ * @internal
+ */
+declare enum SchemaFieldType {
+    Number = "number",
+    Bigint = "bigint",
+    String = "string",
+    Geometry = "geometry",
+    Timestamp = "timestamp",
+    Object = "object",
+    Boolean = "boolean",
+    Variant = "variant",
+    Unknown = "unknown"
+}
+/**
+ * @privateRemarks Source: @deck.gl/carto
+ * @internal
+ */
+interface SchemaField {
+    name: string;
+    type: SchemaFieldType;
+}
 /******************************************************************************
  * LOCAL CALCULATIONS
  */
@@ -630,6 +656,7 @@ type RasterMetadata = {
 };
 type TilejsonResult = Tilejson & {
     accessToken: string;
+    schema: SchemaField[];
 };
 type QueryResult = {
     meta: {
@@ -697,7 +724,7 @@ declare function calculateClusterRadius(properties: {
     max: number;
 }>, radiusRange: [number, number], column: string): number;
 /** @privateRemarks Source: Builder */
-declare function getDefaultAggregationExpColumnAliasForLayerType(layerType: LayerType, provider: ProviderType, columns: string[]): string;
+declare function getDefaultAggregationExpColumnAliasForLayerType(layerType: LayerType, provider: ProviderType, schema: SchemaField[]): string;
 /** @privateRemarks Source: Builder */
 declare function calculateClusterTextFontSize(radius: number): number;
 

package/build/api-client.js

@@ -11295,7 +11295,7 @@ async function baseSource(endpoint, options, urlParameters) {
     type: endpoint,
     source: JSON.stringify(parameters, void 0, 2)
   };
-  const mapInstantiation = await requestWithParameters({
+  const { tilejson, schema } = await requestWithParameters({
     baseUrl,
     parameters,
     headers,
@@ -11303,7 +11303,7 @@ async function baseSource(endpoint, options, urlParameters) {
     maxLengthURL,
     localCache
   });
-  const dataUrl = mapInstantiation.tilejson.url[0];
+  const dataUrl = tilejson.url[0];
   if (cache) {
     cache.value = parseInt(
       new URL(dataUrl).searchParams.get("cache") || "",
@@ -11322,6 +11322,9 @@ async function baseSource(endpoint, options, urlParameters) {
   if (accessToken) {
     json.accessToken = accessToken;
   }
+  if (schema) {
+    json.schema = schema;
+  }
   return json;
 }
 
@@ -14502,10 +14505,10 @@ function calculateClusterRadius(properties, stats, radiusRange, column) {
   const normalizedValue = (value - min3) / (max3 - min3);
   return radiusRange[0] + normalizedValue * (radiusRange[1] - radiusRange[0]);
 }
-function getDefaultAggregationExpColumnAliasForLayerType(layerType, provider, columns) {
-  if (columns && layerType === "clusterTile") {
+function getDefaultAggregationExpColumnAliasForLayerType(layerType, provider, schema) {
+  if (schema && layerType === "clusterTile") {
     return getColumnAliasForAggregationExp(
-      getDefaultColumnFromSchemaForAggregationExp(columns),
+      getDefaultColumnFromSchemaForAggregationExp(schema),
       "count",
       provider
     );
@@ -14517,8 +14520,8 @@ function getColumnAliasForAggregationExp(name, aggregation, provider) {
   const columnAlias = `${name}_${aggregation}`;
   return provider === "snowflake" ? columnAlias.toUpperCase() : columnAlias;
 }
-function getDefaultColumnFromSchemaForAggregationExp(columns) {
-  return columns ? columns[0] : "";
+function getDefaultColumnFromSchemaForAggregationExp(schema) {
+  return schema ? schema[0].name : "";
 }
 function calculateClusterTextFontSize(radius) {
   if (radius >= 80) return 24;
@@ -14715,7 +14718,7 @@ function createChannelProps(id, type, config2, visualChannels, data, dataset) {
     const aggregationExpAlias = getDefaultAggregationExpColumnAliasForLayerType(
       type,
       dataset.providerId,
-      dataset.columns
+      data.schema
     );
     result.pointType = visConfig.isTextVisible ? "circle+text" : "circle";
     result.clusterLevel = visConfig.clusterLevel;