@carto/api-client 0.5.0-alpha.6 → 0.5.0-alpha.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2180,7 +2180,7 @@ async function makeCall({
2180
2180
  method: opts?.method,
2181
2181
  body: opts?.body
2182
2182
  },
2183
- signal: opts?.abortController?.signal,
2183
+ signal: opts?.signal,
2184
2184
  ...opts?.otherOptions
2185
2185
  });
2186
2186
  data = await response.json();
@@ -2315,12 +2315,12 @@ var WidgetRemoteSource = class extends WidgetSource {
2315
2315
  }
2316
2316
  async getCategories(options) {
2317
2317
  const {
2318
+ signal,
2318
2319
  filters = this.props.filters,
2319
2320
  filterOwner,
2320
2321
  spatialFilter,
2321
2322
  spatialFiltersMode,
2322
2323
  spatialIndexReferenceViewState,
2323
- abortController,
2324
2324
  ...params
2325
2325
  } = options;
2326
2326
  const { column, operation, operationColumn } = params;
@@ -2343,17 +2343,17 @@ var WidgetRemoteSource = class extends WidgetSource {
2343
2343
  operation,
2344
2344
  operationColumn: operationColumn || column
2345
2345
  },
2346
- opts: { abortController, headers: this._headers }
2346
+ opts: { signal, headers: this._headers }
2347
2347
  }).then((res) => normalizeObjectKeys(res.rows));
2348
2348
  }
2349
2349
  async getFeatures(options) {
2350
2350
  const {
2351
+ signal,
2351
2352
  filters = this.props.filters,
2352
2353
  filterOwner,
2353
2354
  spatialFilter,
2354
2355
  spatialFiltersMode,
2355
2356
  spatialIndexReferenceViewState,
2356
- abortController,
2357
2357
  ...params
2358
2358
  } = options;
2359
2359
  const { columns, dataType, featureIds, z, limit, tileResolution } = params;
@@ -2379,18 +2379,18 @@ var WidgetRemoteSource = class extends WidgetSource {
2379
2379
  limit: limit || 1e3,
2380
2380
  tileResolution: tileResolution || DEFAULT_TILE_RESOLUTION
2381
2381
  },
2382
- opts: { abortController, headers: this._headers }
2382
+ opts: { signal, headers: this._headers }
2383
2383
  // Avoid `normalizeObjectKeys()`, which changes column names.
2384
2384
  }).then(({ rows }) => ({ rows }));
2385
2385
  }
2386
2386
  async getFormula(options) {
2387
2387
  const {
2388
+ signal,
2388
2389
  filters = this.props.filters,
2389
2390
  filterOwner,
2390
2391
  spatialFilter,
2391
2392
  spatialFiltersMode,
2392
2393
  spatialIndexReferenceViewState,
2393
- abortController,
2394
2394
  operationExp,
2395
2395
  ...params
2396
2396
  } = options;
@@ -2414,17 +2414,17 @@ var WidgetRemoteSource = class extends WidgetSource {
2414
2414
  operation: operation ?? "count",
2415
2415
  operationExp
2416
2416
  },
2417
- opts: { abortController, headers: this._headers }
2417
+ opts: { signal, headers: this._headers }
2418
2418
  }).then((res) => normalizeObjectKeys(res.rows[0]));
2419
2419
  }
2420
2420
  async getHistogram(options) {
2421
2421
  const {
2422
+ signal,
2422
2423
  filters = this.props.filters,
2423
2424
  filterOwner,
2424
2425
  spatialFilter,
2425
2426
  spatialFiltersMode,
2426
2427
  spatialIndexReferenceViewState,
2427
- abortController,
2428
2428
  ...params
2429
2429
  } = options;
2430
2430
  const { column, operation, ticks } = params;
@@ -2443,7 +2443,7 @@ var WidgetRemoteSource = class extends WidgetSource {
2443
2443
  spatialFilter
2444
2444
  },
2445
2445
  params: { column, operation, ticks },
2446
- opts: { abortController, headers: this._headers }
2446
+ opts: { signal, headers: this._headers }
2447
2447
  }).then((res) => normalizeObjectKeys(res.rows));
2448
2448
  if (data.length) {
2449
2449
  const result = Array(ticks.length + 1).fill(0);
@@ -2456,12 +2456,12 @@ var WidgetRemoteSource = class extends WidgetSource {
2456
2456
  }
2457
2457
  async getRange(options) {
2458
2458
  const {
2459
+ signal,
2459
2460
  filters = this.props.filters,
2460
2461
  filterOwner,
2461
2462
  spatialFilter,
2462
2463
  spatialFiltersMode,
2463
2464
  spatialIndexReferenceViewState,
2464
- abortController,
2465
2465
  ...params
2466
2466
  } = options;
2467
2467
  const { column } = params;
@@ -2480,17 +2480,17 @@ var WidgetRemoteSource = class extends WidgetSource {
2480
2480
  spatialFilter
2481
2481
  },
2482
2482
  params: { column },
2483
- opts: { abortController, headers: this._headers }
2483
+ opts: { signal, headers: this._headers }
2484
2484
  }).then((res) => normalizeObjectKeys(res.rows[0]));
2485
2485
  }
2486
2486
  async getScatter(options) {
2487
2487
  const {
2488
+ signal,
2488
2489
  filters = this.props.filters,
2489
2490
  filterOwner,
2490
2491
  spatialFilter,
2491
2492
  spatialFiltersMode,
2492
2493
  spatialIndexReferenceViewState,
2493
- abortController,
2494
2494
  ...params
2495
2495
  } = options;
2496
2496
  const { xAxisColumn, xAxisJoinOperation, yAxisColumn, yAxisJoinOperation } = params;
@@ -2516,17 +2516,17 @@ var WidgetRemoteSource = class extends WidgetSource {
2516
2516
  yAxisJoinOperation,
2517
2517
  limit: HARD_LIMIT
2518
2518
  },
2519
- opts: { abortController, headers: this._headers }
2519
+ opts: { signal, headers: this._headers }
2520
2520
  }).then((res) => normalizeObjectKeys(res.rows)).then((res) => res.map(({ x, y }) => [x, y]));
2521
2521
  }
2522
2522
  async getTable(options) {
2523
2523
  const {
2524
+ signal,
2524
2525
  filters = this.props.filters,
2525
2526
  filterOwner,
2526
2527
  spatialFilter,
2527
2528
  spatialFiltersMode,
2528
2529
  spatialIndexReferenceViewState,
2529
- abortController,
2530
2530
  ...params
2531
2531
  } = options;
2532
2532
  const { columns, sortBy, sortDirection, offset = 0, limit = 10 } = params;
@@ -2551,7 +2551,7 @@ var WidgetRemoteSource = class extends WidgetSource {
2551
2551
  limit,
2552
2552
  offset
2553
2553
  },
2554
- opts: { abortController, headers: this._headers }
2554
+ opts: { signal, headers: this._headers }
2555
2555
  }).then((res) => ({
2556
2556
  // Avoid `normalizeObjectKeys()`, which changes column names.
2557
2557
  rows: res.rows ?? res.ROWS,
@@ -2560,9 +2560,9 @@ var WidgetRemoteSource = class extends WidgetSource {
2560
2560
  }
2561
2561
  async getTimeSeries(options) {
2562
2562
  const {
2563
+ signal,
2563
2564
  filters = this.props.filters,
2564
2565
  filterOwner,
2565
- abortController,
2566
2566
  spatialFilter,
2567
2567
  spatialFiltersMode,
2568
2568
  spatialIndexReferenceViewState,
@@ -2604,7 +2604,7 @@ var WidgetRemoteSource = class extends WidgetSource {
2604
2604
  splitByCategoryLimit,
2605
2605
  splitByCategoryValues
2606
2606
  },
2607
- opts: { abortController, headers: this._headers }
2607
+ opts: { signal, headers: this._headers }
2608
2608
  }).then((res) => ({
2609
2609
  rows: normalizeObjectKeys(res.rows),
2610
2610
  categories: res.metadata?.categories
@@ -3393,74 +3393,46 @@ var WidgetTilesetWorkerSource = class extends WidgetSource {
3393
3393
  throw new Error("getFeatures not supported for tilesets");
3394
3394
  }
3395
3395
  async getFormula({
3396
- abortController,
3396
+ signal,
3397
3397
  ...options
3398
3398
  }) {
3399
- return this._executeWorkerMethod(
3400
- "getFormula" /* GET_FORMULA */,
3401
- [options],
3402
- abortController?.signal
3403
- );
3399
+ return this._executeWorkerMethod("getFormula" /* GET_FORMULA */, [options], signal);
3404
3400
  }
3405
3401
  async getHistogram({
3406
- abortController,
3402
+ signal,
3407
3403
  ...options
3408
3404
  }) {
3409
- return this._executeWorkerMethod(
3410
- "getHistogram" /* GET_HISTOGRAM */,
3411
- [options],
3412
- abortController?.signal
3413
- );
3405
+ return this._executeWorkerMethod("getHistogram" /* GET_HISTOGRAM */, [options], signal);
3414
3406
  }
3415
3407
  async getCategories({
3416
- abortController,
3408
+ signal,
3417
3409
  ...options
3418
3410
  }) {
3419
- return this._executeWorkerMethod(
3420
- "getCategories" /* GET_CATEGORIES */,
3421
- [options],
3422
- abortController?.signal
3423
- );
3411
+ return this._executeWorkerMethod("getCategories" /* GET_CATEGORIES */, [options], signal);
3424
3412
  }
3425
3413
  async getScatter({
3426
- abortController,
3414
+ signal,
3427
3415
  ...options
3428
3416
  }) {
3429
- return this._executeWorkerMethod(
3430
- "getScatter" /* GET_SCATTER */,
3431
- [options],
3432
- abortController?.signal
3433
- );
3417
+ return this._executeWorkerMethod("getScatter" /* GET_SCATTER */, [options], signal);
3434
3418
  }
3435
3419
  async getTable({
3436
- abortController,
3420
+ signal,
3437
3421
  ...options
3438
3422
  }) {
3439
- return this._executeWorkerMethod(
3440
- "getTable" /* GET_TABLE */,
3441
- [options],
3442
- abortController?.signal
3443
- );
3423
+ return this._executeWorkerMethod("getTable" /* GET_TABLE */, [options], signal);
3444
3424
  }
3445
3425
  async getTimeSeries({
3446
- abortController,
3426
+ signal,
3447
3427
  ...options
3448
3428
  }) {
3449
- return this._executeWorkerMethod(
3450
- "getTimeSeries" /* GET_TIME_SERIES */,
3451
- [options],
3452
- abortController?.signal
3453
- );
3429
+ return this._executeWorkerMethod("getTimeSeries" /* GET_TIME_SERIES */, [options], signal);
3454
3430
  }
3455
3431
  async getRange({
3456
- abortController,
3432
+ signal,
3457
3433
  ...options
3458
3434
  }) {
3459
- return this._executeWorkerMethod(
3460
- "getRange" /* GET_RANGE */,
3461
- [options],
3462
- abortController?.signal
3463
- );
3435
+ return this._executeWorkerMethod("getRange" /* GET_RANGE */, [options], signal);
3464
3436
  }
3465
3437
  };
3466
3438
 
@@ -681,11 +681,11 @@ interface ViewState {
681
681
  }
682
682
  /** Common options for {@link WidgetRemoteSource} requests. */
683
683
  interface BaseRequestOptions {
684
+ signal?: AbortSignal;
684
685
  spatialFilter?: SpatialFilter;
685
686
  spatialFiltersMode?: SpatialFilterPolyfillMode;
686
687
  /** Required for table- and query-based spatial index sources (H3, Quadbin). */
687
688
  spatialIndexReferenceViewState?: ViewState;
688
- abortController?: AbortController;
689
689
  /** Overrides source filters, if any. */
690
690
  filters?: Filters;
691
691
  filterOwner?: string;
@@ -1184,13 +1184,13 @@ declare class WidgetTilesetWorkerSource extends WidgetSource<WidgetTilesetSource
1184
1184
  spatialFilter: SpatialFilter;
1185
1185
  }): void;
1186
1186
  getFeatures(): Promise<FeaturesResponse>;
1187
- getFormula({ abortController, ...options }: FormulaRequestOptions): Promise<FormulaResponse>;
1188
- getHistogram({ abortController, ...options }: HistogramRequestOptions): Promise<HistogramResponse>;
1189
- getCategories({ abortController, ...options }: CategoryRequestOptions): Promise<CategoryResponse>;
1190
- getScatter({ abortController, ...options }: ScatterRequestOptions): Promise<ScatterResponse>;
1191
- getTable({ abortController, ...options }: TableRequestOptions): Promise<TableResponse>;
1192
- getTimeSeries({ abortController, ...options }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
1193
- getRange({ abortController, ...options }: RangeRequestOptions): Promise<RangeResponse>;
1187
+ getFormula({ signal, ...options }: FormulaRequestOptions): Promise<FormulaResponse>;
1188
+ getHistogram({ signal, ...options }: HistogramRequestOptions): Promise<HistogramResponse>;
1189
+ getCategories({ signal, ...options }: CategoryRequestOptions): Promise<CategoryResponse>;
1190
+ getScatter({ signal, ...options }: ScatterRequestOptions): Promise<ScatterResponse>;
1191
+ getTable({ signal, ...options }: TableRequestOptions): Promise<TableResponse>;
1192
+ getTimeSeries({ signal, ...options }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
1193
+ getRange({ signal, ...options }: RangeRequestOptions): Promise<RangeResponse>;
1194
1194
  }
1195
1195
 
1196
1196
  type H3QuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
@@ -681,11 +681,11 @@ interface ViewState {
681
681
  }
682
682
  /** Common options for {@link WidgetRemoteSource} requests. */
683
683
  interface BaseRequestOptions {
684
+ signal?: AbortSignal;
684
685
  spatialFilter?: SpatialFilter;
685
686
  spatialFiltersMode?: SpatialFilterPolyfillMode;
686
687
  /** Required for table- and query-based spatial index sources (H3, Quadbin). */
687
688
  spatialIndexReferenceViewState?: ViewState;
688
- abortController?: AbortController;
689
689
  /** Overrides source filters, if any. */
690
690
  filters?: Filters;
691
691
  filterOwner?: string;
@@ -1184,13 +1184,13 @@ declare class WidgetTilesetWorkerSource extends WidgetSource<WidgetTilesetSource
1184
1184
  spatialFilter: SpatialFilter;
1185
1185
  }): void;
1186
1186
  getFeatures(): Promise<FeaturesResponse>;
1187
- getFormula({ abortController, ...options }: FormulaRequestOptions): Promise<FormulaResponse>;
1188
- getHistogram({ abortController, ...options }: HistogramRequestOptions): Promise<HistogramResponse>;
1189
- getCategories({ abortController, ...options }: CategoryRequestOptions): Promise<CategoryResponse>;
1190
- getScatter({ abortController, ...options }: ScatterRequestOptions): Promise<ScatterResponse>;
1191
- getTable({ abortController, ...options }: TableRequestOptions): Promise<TableResponse>;
1192
- getTimeSeries({ abortController, ...options }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
1193
- getRange({ abortController, ...options }: RangeRequestOptions): Promise<RangeResponse>;
1187
+ getFormula({ signal, ...options }: FormulaRequestOptions): Promise<FormulaResponse>;
1188
+ getHistogram({ signal, ...options }: HistogramRequestOptions): Promise<HistogramResponse>;
1189
+ getCategories({ signal, ...options }: CategoryRequestOptions): Promise<CategoryResponse>;
1190
+ getScatter({ signal, ...options }: ScatterRequestOptions): Promise<ScatterResponse>;
1191
+ getTable({ signal, ...options }: TableRequestOptions): Promise<TableResponse>;
1192
+ getTimeSeries({ signal, ...options }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse>;
1193
+ getRange({ signal, ...options }: RangeRequestOptions): Promise<RangeResponse>;
1194
1194
  }
1195
1195
 
1196
1196
  type H3QuerySourceOptions = SourceOptions & QuerySourceOptions & AggregationOptions & FilterOptions;
@@ -653,7 +653,7 @@ async function makeCall({
653
653
  method: opts?.method,
654
654
  body: opts?.body
655
655
  },
656
- signal: opts?.abortController?.signal,
656
+ signal: opts?.signal,
657
657
  ...opts?.otherOptions
658
658
  });
659
659
  data = await response.json();
@@ -788,12 +788,12 @@ var WidgetRemoteSource = class extends WidgetSource {
788
788
  }
789
789
  async getCategories(options) {
790
790
  const {
791
+ signal,
791
792
  filters = this.props.filters,
792
793
  filterOwner,
793
794
  spatialFilter,
794
795
  spatialFiltersMode,
795
796
  spatialIndexReferenceViewState,
796
- abortController,
797
797
  ...params
798
798
  } = options;
799
799
  const { column, operation, operationColumn } = params;
@@ -816,17 +816,17 @@ var WidgetRemoteSource = class extends WidgetSource {
816
816
  operation,
817
817
  operationColumn: operationColumn || column
818
818
  },
819
- opts: { abortController, headers: this._headers }
819
+ opts: { signal, headers: this._headers }
820
820
  }).then((res) => normalizeObjectKeys(res.rows));
821
821
  }
822
822
  async getFeatures(options) {
823
823
  const {
824
+ signal,
824
825
  filters = this.props.filters,
825
826
  filterOwner,
826
827
  spatialFilter,
827
828
  spatialFiltersMode,
828
829
  spatialIndexReferenceViewState,
829
- abortController,
830
830
  ...params
831
831
  } = options;
832
832
  const { columns, dataType, featureIds, z, limit, tileResolution } = params;
@@ -852,18 +852,18 @@ var WidgetRemoteSource = class extends WidgetSource {
852
852
  limit: limit || 1e3,
853
853
  tileResolution: tileResolution || DEFAULT_TILE_RESOLUTION
854
854
  },
855
- opts: { abortController, headers: this._headers }
855
+ opts: { signal, headers: this._headers }
856
856
  // Avoid `normalizeObjectKeys()`, which changes column names.
857
857
  }).then(({ rows }) => ({ rows }));
858
858
  }
859
859
  async getFormula(options) {
860
860
  const {
861
+ signal,
861
862
  filters = this.props.filters,
862
863
  filterOwner,
863
864
  spatialFilter,
864
865
  spatialFiltersMode,
865
866
  spatialIndexReferenceViewState,
866
- abortController,
867
867
  operationExp,
868
868
  ...params
869
869
  } = options;
@@ -887,17 +887,17 @@ var WidgetRemoteSource = class extends WidgetSource {
887
887
  operation: operation ?? "count",
888
888
  operationExp
889
889
  },
890
- opts: { abortController, headers: this._headers }
890
+ opts: { signal, headers: this._headers }
891
891
  }).then((res) => normalizeObjectKeys(res.rows[0]));
892
892
  }
893
893
  async getHistogram(options) {
894
894
  const {
895
+ signal,
895
896
  filters = this.props.filters,
896
897
  filterOwner,
897
898
  spatialFilter,
898
899
  spatialFiltersMode,
899
900
  spatialIndexReferenceViewState,
900
- abortController,
901
901
  ...params
902
902
  } = options;
903
903
  const { column, operation, ticks } = params;
@@ -916,7 +916,7 @@ var WidgetRemoteSource = class extends WidgetSource {
916
916
  spatialFilter
917
917
  },
918
918
  params: { column, operation, ticks },
919
- opts: { abortController, headers: this._headers }
919
+ opts: { signal, headers: this._headers }
920
920
  }).then((res) => normalizeObjectKeys(res.rows));
921
921
  if (data.length) {
922
922
  const result = Array(ticks.length + 1).fill(0);
@@ -929,12 +929,12 @@ var WidgetRemoteSource = class extends WidgetSource {
929
929
  }
930
930
  async getRange(options) {
931
931
  const {
932
+ signal,
932
933
  filters = this.props.filters,
933
934
  filterOwner,
934
935
  spatialFilter,
935
936
  spatialFiltersMode,
936
937
  spatialIndexReferenceViewState,
937
- abortController,
938
938
  ...params
939
939
  } = options;
940
940
  const { column } = params;
@@ -953,17 +953,17 @@ var WidgetRemoteSource = class extends WidgetSource {
953
953
  spatialFilter
954
954
  },
955
955
  params: { column },
956
- opts: { abortController, headers: this._headers }
956
+ opts: { signal, headers: this._headers }
957
957
  }).then((res) => normalizeObjectKeys(res.rows[0]));
958
958
  }
959
959
  async getScatter(options) {
960
960
  const {
961
+ signal,
961
962
  filters = this.props.filters,
962
963
  filterOwner,
963
964
  spatialFilter,
964
965
  spatialFiltersMode,
965
966
  spatialIndexReferenceViewState,
966
- abortController,
967
967
  ...params
968
968
  } = options;
969
969
  const { xAxisColumn, xAxisJoinOperation, yAxisColumn, yAxisJoinOperation } = params;
@@ -989,17 +989,17 @@ var WidgetRemoteSource = class extends WidgetSource {
989
989
  yAxisJoinOperation,
990
990
  limit: HARD_LIMIT
991
991
  },
992
- opts: { abortController, headers: this._headers }
992
+ opts: { signal, headers: this._headers }
993
993
  }).then((res) => normalizeObjectKeys(res.rows)).then((res) => res.map(({ x, y }) => [x, y]));
994
994
  }
995
995
  async getTable(options) {
996
996
  const {
997
+ signal,
997
998
  filters = this.props.filters,
998
999
  filterOwner,
999
1000
  spatialFilter,
1000
1001
  spatialFiltersMode,
1001
1002
  spatialIndexReferenceViewState,
1002
- abortController,
1003
1003
  ...params
1004
1004
  } = options;
1005
1005
  const { columns, sortBy, sortDirection, offset = 0, limit = 10 } = params;
@@ -1024,7 +1024,7 @@ var WidgetRemoteSource = class extends WidgetSource {
1024
1024
  limit,
1025
1025
  offset
1026
1026
  },
1027
- opts: { abortController, headers: this._headers }
1027
+ opts: { signal, headers: this._headers }
1028
1028
  }).then((res) => ({
1029
1029
  // Avoid `normalizeObjectKeys()`, which changes column names.
1030
1030
  rows: res.rows ?? res.ROWS,
@@ -1033,9 +1033,9 @@ var WidgetRemoteSource = class extends WidgetSource {
1033
1033
  }
1034
1034
  async getTimeSeries(options) {
1035
1035
  const {
1036
+ signal,
1036
1037
  filters = this.props.filters,
1037
1038
  filterOwner,
1038
- abortController,
1039
1039
  spatialFilter,
1040
1040
  spatialFiltersMode,
1041
1041
  spatialIndexReferenceViewState,
@@ -1077,7 +1077,7 @@ var WidgetRemoteSource = class extends WidgetSource {
1077
1077
  splitByCategoryLimit,
1078
1078
  splitByCategoryValues
1079
1079
  },
1080
- opts: { abortController, headers: this._headers }
1080
+ opts: { signal, headers: this._headers }
1081
1081
  }).then((res) => ({
1082
1082
  rows: normalizeObjectKeys(res.rows),
1083
1083
  categories: res.metadata?.categories
@@ -1226,74 +1226,46 @@ var WidgetTilesetWorkerSource = class extends WidgetSource {
1226
1226
  throw new Error("getFeatures not supported for tilesets");
1227
1227
  }
1228
1228
  async getFormula({
1229
- abortController,
1229
+ signal,
1230
1230
  ...options
1231
1231
  }) {
1232
- return this._executeWorkerMethod(
1233
- "getFormula" /* GET_FORMULA */,
1234
- [options],
1235
- abortController?.signal
1236
- );
1232
+ return this._executeWorkerMethod("getFormula" /* GET_FORMULA */, [options], signal);
1237
1233
  }
1238
1234
  async getHistogram({
1239
- abortController,
1235
+ signal,
1240
1236
  ...options
1241
1237
  }) {
1242
- return this._executeWorkerMethod(
1243
- "getHistogram" /* GET_HISTOGRAM */,
1244
- [options],
1245
- abortController?.signal
1246
- );
1238
+ return this._executeWorkerMethod("getHistogram" /* GET_HISTOGRAM */, [options], signal);
1247
1239
  }
1248
1240
  async getCategories({
1249
- abortController,
1241
+ signal,
1250
1242
  ...options
1251
1243
  }) {
1252
- return this._executeWorkerMethod(
1253
- "getCategories" /* GET_CATEGORIES */,
1254
- [options],
1255
- abortController?.signal
1256
- );
1244
+ return this._executeWorkerMethod("getCategories" /* GET_CATEGORIES */, [options], signal);
1257
1245
  }
1258
1246
  async getScatter({
1259
- abortController,
1247
+ signal,
1260
1248
  ...options
1261
1249
  }) {
1262
- return this._executeWorkerMethod(
1263
- "getScatter" /* GET_SCATTER */,
1264
- [options],
1265
- abortController?.signal
1266
- );
1250
+ return this._executeWorkerMethod("getScatter" /* GET_SCATTER */, [options], signal);
1267
1251
  }
1268
1252
  async getTable({
1269
- abortController,
1253
+ signal,
1270
1254
  ...options
1271
1255
  }) {
1272
- return this._executeWorkerMethod(
1273
- "getTable" /* GET_TABLE */,
1274
- [options],
1275
- abortController?.signal
1276
- );
1256
+ return this._executeWorkerMethod("getTable" /* GET_TABLE */, [options], signal);
1277
1257
  }
1278
1258
  async getTimeSeries({
1279
- abortController,
1259
+ signal,
1280
1260
  ...options
1281
1261
  }) {
1282
- return this._executeWorkerMethod(
1283
- "getTimeSeries" /* GET_TIME_SERIES */,
1284
- [options],
1285
- abortController?.signal
1286
- );
1262
+ return this._executeWorkerMethod("getTimeSeries" /* GET_TIME_SERIES */, [options], signal);
1287
1263
  }
1288
1264
  async getRange({
1289
- abortController,
1265
+ signal,
1290
1266
  ...options
1291
1267
  }) {
1292
- return this._executeWorkerMethod(
1293
- "getRange" /* GET_RANGE */,
1294
- [options],
1295
- abortController?.signal
1296
- );
1268
+ return this._executeWorkerMethod("getRange" /* GET_RANGE */, [options], signal);
1297
1269
  }
1298
1270
  };
1299
1271
 
package/package.json CHANGED
@@ -8,12 +8,8 @@
8
8
  "homepage": "https://github.com/CartoDB/carto-api-client#readme",
9
9
  "author": "Don McCurdy <donmccurdy@carto.com>",
10
10
  "packageManager": "yarn@4.3.1",
11
- "version": "0.5.0-alpha.6",
11
+ "version": "0.5.0-alpha.7",
12
12
  "license": "MIT",
13
- "publishConfig": {
14
- "access": "public",
15
- "tag": "alpha"
16
- },
17
13
  "type": "module",
18
14
  "sideEffects": false,
19
15
  "exports": {
@@ -4,7 +4,7 @@ import {InvalidColumnError} from '../utils.js';
4
4
  export interface ModelRequestOptions {
5
5
  method: 'GET' | 'POST';
6
6
  headers?: Record<string, string>;
7
- abortController?: AbortController;
7
+ signal?: AbortSignal;
8
8
  otherOptions?: Record<string, unknown>;
9
9
  body?: string;
10
10
  }
@@ -75,7 +75,7 @@ export async function makeCall({
75
75
  method: opts?.method,
76
76
  body: opts?.body,
77
77
  }),
78
- signal: opts?.abortController?.signal,
78
+ signal: opts?.signal,
79
79
  ...opts?.otherOptions,
80
80
  });
81
81
  data = await response.json();
@@ -19,11 +19,11 @@ export interface ViewState {
19
19
 
20
20
  /** Common options for {@link WidgetRemoteSource} requests. */
21
21
  interface BaseRequestOptions {
22
+ signal?: AbortSignal;
22
23
  spatialFilter?: SpatialFilter;
23
24
  spatialFiltersMode?: SpatialFilterPolyfillMode;
24
25
  /** Required for table- and query-based spatial index sources (H3, Quadbin). */
25
26
  spatialIndexReferenceViewState?: ViewState;
26
- abortController?: AbortController;
27
27
  /** Overrides source filters, if any. */
28
28
  filters?: Filters;
29
29
  filterOwner?: string;
@@ -75,12 +75,12 @@ export abstract class WidgetRemoteSource<
75
75
  options: CategoryRequestOptions
76
76
  ): Promise<CategoryResponse> {
77
77
  const {
78
+ signal,
78
79
  filters = this.props.filters,
79
80
  filterOwner,
80
81
  spatialFilter,
81
82
  spatialFiltersMode,
82
83
  spatialIndexReferenceViewState,
83
- abortController,
84
84
  ...params
85
85
  } = options;
86
86
  const {column, operation, operationColumn} = params;
@@ -106,7 +106,7 @@ export abstract class WidgetRemoteSource<
106
106
  operation,
107
107
  operationColumn: operationColumn || column,
108
108
  },
109
- opts: {abortController, headers: this._headers},
109
+ opts: {signal, headers: this._headers},
110
110
  }).then((res: CategoriesModelResponse) => normalizeObjectKeys(res.rows));
111
111
  }
112
112
 
@@ -114,12 +114,12 @@ export abstract class WidgetRemoteSource<
114
114
  options: FeaturesRequestOptions
115
115
  ): Promise<FeaturesResponse> {
116
116
  const {
117
+ signal,
117
118
  filters = this.props.filters,
118
119
  filterOwner,
119
120
  spatialFilter,
120
121
  spatialFiltersMode,
121
122
  spatialIndexReferenceViewState,
122
- abortController,
123
123
  ...params
124
124
  } = options;
125
125
  const {columns, dataType, featureIds, z, limit, tileResolution} = params;
@@ -148,19 +148,19 @@ export abstract class WidgetRemoteSource<
148
148
  limit: limit || 1000,
149
149
  tileResolution: tileResolution || DEFAULT_TILE_RESOLUTION,
150
150
  },
151
- opts: {abortController, headers: this._headers},
151
+ opts: {signal, headers: this._headers},
152
152
  // Avoid `normalizeObjectKeys()`, which changes column names.
153
153
  }).then(({rows}: FeaturesModelResponse) => ({rows}));
154
154
  }
155
155
 
156
156
  async getFormula(options: FormulaRequestOptions): Promise<FormulaResponse> {
157
157
  const {
158
+ signal,
158
159
  filters = this.props.filters,
159
160
  filterOwner,
160
161
  spatialFilter,
161
162
  spatialFiltersMode,
162
163
  spatialIndexReferenceViewState,
163
- abortController,
164
164
  operationExp,
165
165
  ...params
166
166
  } = options;
@@ -187,7 +187,7 @@ export abstract class WidgetRemoteSource<
187
187
  operation: operation ?? 'count',
188
188
  operationExp,
189
189
  },
190
- opts: {abortController, headers: this._headers},
190
+ opts: {signal, headers: this._headers},
191
191
  }).then((res: FormulaModelResponse) => normalizeObjectKeys(res.rows[0]));
192
192
  }
193
193
 
@@ -195,12 +195,12 @@ export abstract class WidgetRemoteSource<
195
195
  options: HistogramRequestOptions
196
196
  ): Promise<HistogramResponse> {
197
197
  const {
198
+ signal,
198
199
  filters = this.props.filters,
199
200
  filterOwner,
200
201
  spatialFilter,
201
202
  spatialFiltersMode,
202
203
  spatialIndexReferenceViewState,
203
- abortController,
204
204
  ...params
205
205
  } = options;
206
206
  const {column, operation, ticks} = params;
@@ -222,7 +222,7 @@ export abstract class WidgetRemoteSource<
222
222
  spatialFilter,
223
223
  },
224
224
  params: {column, operation, ticks},
225
- opts: {abortController, headers: this._headers},
225
+ opts: {signal, headers: this._headers},
226
226
  }).then((res: HistogramModelResponse) => normalizeObjectKeys(res.rows));
227
227
 
228
228
  if (data.length) {
@@ -240,12 +240,12 @@ export abstract class WidgetRemoteSource<
240
240
 
241
241
  async getRange(options: RangeRequestOptions): Promise<RangeResponse> {
242
242
  const {
243
+ signal,
243
244
  filters = this.props.filters,
244
245
  filterOwner,
245
246
  spatialFilter,
246
247
  spatialFiltersMode,
247
248
  spatialIndexReferenceViewState,
248
- abortController,
249
249
  ...params
250
250
  } = options;
251
251
  const {column} = params;
@@ -267,18 +267,18 @@ export abstract class WidgetRemoteSource<
267
267
  spatialFilter,
268
268
  },
269
269
  params: {column},
270
- opts: {abortController, headers: this._headers},
270
+ opts: {signal, headers: this._headers},
271
271
  }).then((res: RangeModelResponse) => normalizeObjectKeys(res.rows[0]));
272
272
  }
273
273
 
274
274
  async getScatter(options: ScatterRequestOptions): Promise<ScatterResponse> {
275
275
  const {
276
+ signal,
276
277
  filters = this.props.filters,
277
278
  filterOwner,
278
279
  spatialFilter,
279
280
  spatialFiltersMode,
280
281
  spatialIndexReferenceViewState,
281
- abortController,
282
282
  ...params
283
283
  } = options;
284
284
  const {xAxisColumn, xAxisJoinOperation, yAxisColumn, yAxisJoinOperation} =
@@ -311,7 +311,7 @@ export abstract class WidgetRemoteSource<
311
311
  yAxisJoinOperation,
312
312
  limit: HARD_LIMIT,
313
313
  },
314
- opts: {abortController, headers: this._headers},
314
+ opts: {signal, headers: this._headers},
315
315
  })
316
316
  .then((res: ScatterModelResponse) => normalizeObjectKeys(res.rows))
317
317
  .then((res) => res.map(({x, y}: {x: number; y: number}) => [x, y]));
@@ -319,12 +319,12 @@ export abstract class WidgetRemoteSource<
319
319
 
320
320
  async getTable(options: TableRequestOptions): Promise<TableResponse> {
321
321
  const {
322
+ signal,
322
323
  filters = this.props.filters,
323
324
  filterOwner,
324
325
  spatialFilter,
325
326
  spatialFiltersMode,
326
327
  spatialIndexReferenceViewState,
327
- abortController,
328
328
  ...params
329
329
  } = options;
330
330
  const {columns, sortBy, sortDirection, offset = 0, limit = 10} = params;
@@ -355,7 +355,7 @@ export abstract class WidgetRemoteSource<
355
355
  limit,
356
356
  offset,
357
357
  },
358
- opts: {abortController, headers: this._headers},
358
+ opts: {signal, headers: this._headers},
359
359
  }).then((res: TableModelResponse) => ({
360
360
  // Avoid `normalizeObjectKeys()`, which changes column names.
361
361
  rows: res.rows ?? (res as any).ROWS,
@@ -367,9 +367,9 @@ export abstract class WidgetRemoteSource<
367
367
  options: TimeSeriesRequestOptions
368
368
  ): Promise<TimeSeriesResponse> {
369
369
  const {
370
+ signal,
370
371
  filters = this.props.filters,
371
372
  filterOwner,
372
- abortController,
373
373
  spatialFilter,
374
374
  spatialFiltersMode,
375
375
  spatialIndexReferenceViewState,
@@ -418,7 +418,7 @@ export abstract class WidgetRemoteSource<
418
418
  splitByCategoryLimit,
419
419
  splitByCategoryValues,
420
420
  },
421
- opts: {abortController, headers: this._headers},
421
+ opts: {signal, headers: this._headers},
422
422
  }).then((res: TimeSeriesModelResponse) => ({
423
423
  rows: normalizeObjectKeys(res.rows),
424
424
  categories: res.metadata?.categories,
@@ -190,79 +190,51 @@ export class WidgetTilesetWorkerSource extends WidgetSource<WidgetTilesetSourceP
190
190
  }
191
191
 
192
192
  async getFormula({
193
- abortController,
193
+ signal,
194
194
  ...options
195
195
  }: FormulaRequestOptions): Promise<FormulaResponse> {
196
- return this._executeWorkerMethod(
197
- Method.GET_FORMULA,
198
- [options],
199
- abortController?.signal
200
- );
196
+ return this._executeWorkerMethod(Method.GET_FORMULA, [options], signal);
201
197
  }
202
198
 
203
199
  override async getHistogram({
204
- abortController,
200
+ signal,
205
201
  ...options
206
202
  }: HistogramRequestOptions): Promise<HistogramResponse> {
207
- return this._executeWorkerMethod(
208
- Method.GET_HISTOGRAM,
209
- [options],
210
- abortController?.signal
211
- );
203
+ return this._executeWorkerMethod(Method.GET_HISTOGRAM, [options], signal);
212
204
  }
213
205
 
214
206
  override async getCategories({
215
- abortController,
207
+ signal,
216
208
  ...options
217
209
  }: CategoryRequestOptions): Promise<CategoryResponse> {
218
- return this._executeWorkerMethod(
219
- Method.GET_CATEGORIES,
220
- [options],
221
- abortController?.signal
222
- );
210
+ return this._executeWorkerMethod(Method.GET_CATEGORIES, [options], signal);
223
211
  }
224
212
 
225
213
  override async getScatter({
226
- abortController,
214
+ signal,
227
215
  ...options
228
216
  }: ScatterRequestOptions): Promise<ScatterResponse> {
229
- return this._executeWorkerMethod(
230
- Method.GET_SCATTER,
231
- [options],
232
- abortController?.signal
233
- );
217
+ return this._executeWorkerMethod(Method.GET_SCATTER, [options], signal);
234
218
  }
235
219
 
236
220
  override async getTable({
237
- abortController,
221
+ signal,
238
222
  ...options
239
223
  }: TableRequestOptions): Promise<TableResponse> {
240
- return this._executeWorkerMethod(
241
- Method.GET_TABLE,
242
- [options],
243
- abortController?.signal
244
- );
224
+ return this._executeWorkerMethod(Method.GET_TABLE, [options], signal);
245
225
  }
246
226
 
247
227
  override async getTimeSeries({
248
- abortController,
228
+ signal,
249
229
  ...options
250
230
  }: TimeSeriesRequestOptions): Promise<TimeSeriesResponse> {
251
- return this._executeWorkerMethod(
252
- Method.GET_TIME_SERIES,
253
- [options],
254
- abortController?.signal
255
- );
231
+ return this._executeWorkerMethod(Method.GET_TIME_SERIES, [options], signal);
256
232
  }
257
233
 
258
234
  override async getRange({
259
- abortController,
235
+ signal,
260
236
  ...options
261
237
  }: RangeRequestOptions): Promise<RangeResponse> {
262
- return this._executeWorkerMethod(
263
- Method.GET_RANGE,
264
- [options],
265
- abortController?.signal
266
- );
238
+ return this._executeWorkerMethod(Method.GET_RANGE, [options], signal);
267
239
  }
268
240
  }