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

package/build/sources/vector-table-source.d.ts

@@ -1,3 +1,4 @@
+import { WidgetTableSourceResult } from '../widget-sources/index.js';
 import type { FilterOptions, ColumnsOption, SourceOptions, TableSourceOptions, TilejsonResult } from './types';
 export type VectorTableSourceOptions = SourceOptions & TableSourceOptions & FilterOptions & ColumnsOption;
-export declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<TilejsonResult>;
+export declare const vectorTableSource: (options: VectorTableSourceOptions) => Promise<TilejsonResult & WidgetTableSourceResult>;

package/build/widget-sources/index.d.ts

@@ -1,5 +1,4 @@
 export * from './widget-base-source.js';
 export * from './widget-query-source.js';
 export * from './widget-table-source.js';
-export * from './wrappers.js';
 export * from './types.js';

package/build/widget-sources/widget-query-source.d.ts

@@ -2,6 +2,9 @@ import { H3QuerySourceOptions, QuadbinQuerySourceOptions, VectorQuerySourceOptio
 import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
 import { ModelSource } from '../models/model.js';
 type LayerQuerySourceOptions = Omit<VectorQuerySourceOptions, 'filters'> | Omit<H3QuerySourceOptions, 'filters'> | Omit<QuadbinQuerySourceOptions, 'filters'>;
+export type WidgetQuerySourceResult = {
+    widgetSource: WidgetQuerySource;
+};
 /**
  * Source for Widget API requests on a data source defined by a SQL query.
  *

package/build/widget-sources/widget-table-source.d.ts

@@ -2,6 +2,9 @@ import { H3TableSourceOptions, QuadbinTableSourceOptions, VectorTableSourceOptio
 import { WidgetBaseSource, WidgetBaseSourceProps } from './widget-base-source.js';
 import { ModelSource } from '../models/model.js';
 type LayerTableSourceOptions = Omit<VectorTableSourceOptions, 'filters'> | Omit<H3TableSourceOptions, 'filters'> | Omit<QuadbinTableSourceOptions, 'filters'>;
+export type WidgetTableSourceResult = {
+    widgetSource: WidgetTableSource;
+};
 /**
  * Source for Widget API requests on a data source defined as a table.
  *

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-alpha.1",
+  "version": "0.4.0-alpha.3",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
@@ -34,7 +34,7 @@
     "dev": "concurrently \"yarn build:watch\" \"vite --config examples/vite.config.ts --open\"",
     "test": "vitest run --typecheck",
     "test:watch": "vitest watch --typecheck",
-    "coverage": "vitest run --coverage",
+    "coverage": "vitest run --coverage.enabled --coverage.all false",
     "lint": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --check",
     "format": "prettier \"**/*.{cjs,html,js,json,md,ts}\" --ignore-path ./.eslintignore --write",
     "clean": "rimraf build/*",

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

@@ -32,7 +32,7 @@ export async function requestWithParameters<T = any>({
   // user-provided parameters.
   parameters = {
     v: V3_MINOR_VERSION,
-    clientId: DEFAULT_CLIENT,
+    client: DEFAULT_CLIENT,
     ...(typeof deck !== 'undefined' &&
       deck.VERSION && {deckglVersion: deck.VERSION}),
     ...parameters,

package/src/index.ts

@@ -17,27 +17,37 @@ export {
 } from './api/index.js';
 
 export {
+  BoundaryQuerySourceOptions,
+  BoundaryTableSourceOptions,
   GeojsonResult,
+  H3QuerySourceOptions,
+  H3TableSourceOptions,
+  H3TilesetSourceOptions,
   JsonResult,
+  QuadbinQuerySourceOptions,
+  QuadbinTableSourceOptions,
+  QuadbinTilesetSourceOptions,
   QueryResult,
   QuerySourceOptions,
+  RasterSourceOptions,
   SOURCE_DEFAULTS,
   SourceOptions,
   TableSourceOptions,
   TilejsonResult,
   TilesetSourceOptions,
-
-  // Sources not wrapped in './widget-sources/index.js';
-  BoundaryQuerySourceOptions,
-  BoundaryTableSourceOptions,
-  H3TilesetSourceOptions,
-  QuadbinTilesetSourceOptions,
-  RasterSourceOptions,
+  VectorQuerySourceOptions,
+  VectorTableSourceOptions,
   VectorTilesetSourceOptions,
   boundaryQuerySource,
   boundaryTableSource,
+  h3QuerySource,
+  h3TableSource,
   h3TilesetSource,
+  quadbinQuerySource,
+  quadbinTableSource,
   quadbinTilesetSource,
   rasterSource,
+  vectorQuerySource,
+  vectorTableSource,
   vectorTilesetSource,
 } from './sources/index.js';

package/src/sources/h3-query-source.ts

@@ -4,6 +4,7 @@
 
 /* eslint-disable camelcase */
 import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal';
+import {WidgetQuerySource, WidgetQuerySourceResult} from '../widget-sources';
 import {baseSource} from './base-source';
 import type {
   AggregationOptions,
@@ -30,7 +31,7 @@ type UrlParameters = {
 
 export const h3QuerySource = async function (
   options: H3QuerySourceOptions
-): Promise<TilejsonResult> {
+): Promise<TilejsonResult & WidgetQuerySourceResult> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
@@ -55,9 +56,10 @@ export const h3QuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
-  return baseSource<UrlParameters>(
-    'query',
-    options,
-    urlParameters
-  ) as Promise<TilejsonResult>;
+  return baseSource<UrlParameters>('query', options, urlParameters).then(
+    (result) => ({
+      ...(result as TilejsonResult),
+      widgetSource: new WidgetQuerySource(options),
+    })
+  );
 };

package/src/sources/h3-table-source.ts

@@ -4,6 +4,7 @@
 
 /* eslint-disable camelcase */
 import {DEFAULT_AGGREGATION_RES_LEVEL_H3} from '../constants-internal';
+import {WidgetTableSource, WidgetTableSourceResult} from '../widget-sources';
 import {baseSource} from './base-source';
 import type {
   AggregationOptions,
@@ -30,7 +31,7 @@ type UrlParameters = {
 
 export const h3TableSource = async function (
   options: H3TableSourceOptions
-): Promise<TilejsonResult> {
+): Promise<TilejsonResult & WidgetTableSourceResult> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_H3,
@@ -51,9 +52,10 @@ export const h3TableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
-  return baseSource<UrlParameters>(
-    'table',
-    options,
-    urlParameters
-  ) as Promise<TilejsonResult>;
+  return baseSource<UrlParameters>('table', options, urlParameters).then(
+    (result) => ({
+      ...(result as TilejsonResult),
+      widgetSource: new WidgetTableSource(options),
+    })
+  );
 };

package/src/sources/quadbin-query-source.ts

@@ -4,6 +4,7 @@
 
 /* eslint-disable camelcase */
 import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal';
+import {WidgetQuerySource, WidgetQuerySourceResult} from '../widget-sources';
 import {baseSource} from './base-source';
 import type {
   AggregationOptions,
@@ -31,7 +32,7 @@ type UrlParameters = {
 
 export const quadbinQuerySource = async function (
   options: QuadbinQuerySourceOptions
-): Promise<TilejsonResult> {
+): Promise<TilejsonResult & WidgetQuerySourceResult> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
@@ -56,9 +57,10 @@ export const quadbinQuerySource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
-  return baseSource<UrlParameters>(
-    'query',
-    options,
-    urlParameters
-  ) as Promise<TilejsonResult>;
+  return baseSource<UrlParameters>('query', options, urlParameters).then(
+    (result) => ({
+      ...(result as TilejsonResult),
+      widgetSource: new WidgetQuerySource(options),
+    })
+  );
 };

package/src/sources/quadbin-table-source.ts

@@ -4,6 +4,7 @@
 
 /* eslint-disable camelcase */
 import {DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN} from '../constants-internal';
+import {WidgetTableSource, WidgetTableSourceResult} from '../widget-sources';
 import {baseSource} from './base-source';
 import type {
   AggregationOptions,
@@ -30,7 +31,7 @@ type UrlParameters = {
 
 export const quadbinTableSource = async function (
   options: QuadbinTableSourceOptions
-): Promise<TilejsonResult> {
+): Promise<TilejsonResult & WidgetTableSourceResult> {
   const {
     aggregationExp,
     aggregationResLevel = DEFAULT_AGGREGATION_RES_LEVEL_QUADBIN,
@@ -52,9 +53,10 @@ export const quadbinTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
-  return baseSource<UrlParameters>(
-    'table',
-    options,
-    urlParameters
-  ) as Promise<TilejsonResult>;
+  return baseSource<UrlParameters>('table', options, urlParameters).then(
+    (result) => ({
+      ...(result as TilejsonResult),
+      widgetSource: new WidgetTableSource(options),
+    })
+  );
 };

package/src/sources/vector-query-source.ts

@@ -4,6 +4,10 @@
 
 /* eslint-disable camelcase */
 import {DEFAULT_TILE_RESOLUTION} from '../constants.js';
+import {
+  WidgetQuerySource,
+  WidgetQuerySourceResult,
+} from '../widget-sources/index.js';
 import {baseSource} from './base-source';
 import type {
   FilterOptions,
@@ -31,7 +35,7 @@ type UrlParameters = {
 
 export const vectorQuerySource = async function (
   options: VectorQuerySourceOptions
-): Promise<TilejsonResult> {
+): Promise<TilejsonResult & WidgetQuerySourceResult> {
   const {
     columns,
     filters,
@@ -57,9 +61,10 @@ export const vectorQuerySource = async function (
   if (queryParameters) {
     urlParameters.queryParameters = queryParameters;
   }
-  return baseSource<UrlParameters>(
-    'query',
-    options,
-    urlParameters
-  ) as Promise<TilejsonResult>;
+  return baseSource<UrlParameters>('query', options, urlParameters).then(
+    (result) => ({
+      ...(result as TilejsonResult),
+      widgetSource: new WidgetQuerySource(options),
+    })
+  );
 };

package/src/sources/vector-table-source.ts

@@ -4,6 +4,10 @@
 
 /* eslint-disable camelcase */
 import {DEFAULT_TILE_RESOLUTION} from '../constants.js';
+import {
+  WidgetTableSource,
+  WidgetTableSourceResult,
+} from '../widget-sources/index.js';
 import {baseSource} from './base-source';
 import type {
   FilterOptions,
@@ -29,7 +33,7 @@ type UrlParameters = {
 
 export const vectorTableSource = async function (
   options: VectorTableSourceOptions
-): Promise<TilejsonResult> {
+): Promise<TilejsonResult & WidgetTableSourceResult> {
   const {
     columns,
     filters,
@@ -51,9 +55,10 @@ export const vectorTableSource = async function (
   if (filters) {
     urlParameters.filters = filters;
   }
-  return baseSource<UrlParameters>(
-    'table',
-    options,
-    urlParameters
-  ) as Promise<TilejsonResult>;
+  return baseSource<UrlParameters>('table', options, urlParameters).then(
+    (result) => ({
+      ...(result as TilejsonResult),
+      widgetSource: new WidgetTableSource(options),
+    })
+  );
 };

package/src/widget-sources/index.ts

@@ -1,5 +1,4 @@
 export * from './widget-base-source.js';
 export * from './widget-query-source.js';
 export * from './widget-table-source.js';
-export * from './wrappers.js';
 export * from './types.js';

package/src/widget-sources/widget-query-source.ts

@@ -11,6 +11,8 @@ type LayerQuerySourceOptions =
   | Omit<H3QuerySourceOptions, 'filters'>
   | Omit<QuadbinQuerySourceOptions, 'filters'>;
 
+export type WidgetQuerySourceResult = {widgetSource: WidgetQuerySource};
+
 /**
  * Source for Widget API requests on a data source defined by a SQL query.
  *

package/src/widget-sources/widget-table-source.ts

@@ -11,6 +11,8 @@ type LayerTableSourceOptions =
   | Omit<H3TableSourceOptions, 'filters'>
   | Omit<QuadbinTableSourceOptions, 'filters'>;
 
+export type WidgetTableSourceResult = {widgetSource: WidgetTableSource};
+
 /**
  * Source for Widget API requests on a data source defined as a table.
  *

package/build/widget-sources/wrappers.d.ts

@@ -1,48 +0,0 @@
-import { h3TableSource as _h3TableSource, h3QuerySource as _h3QuerySource, vectorTableSource as _vectorTableSource, vectorQuerySource as _vectorQuerySource, quadbinTableSource as _quadbinTableSource, quadbinQuerySource as _quadbinQuerySource, VectorTableSourceOptions as _VectorTableSourceOptions, VectorQuerySourceOptions as _VectorQuerySourceOptions, H3TableSourceOptions as _H3TableSourceOptions, H3QuerySourceOptions as _H3QuerySourceOptions, QuadbinTableSourceOptions as _QuadbinTableSourceOptions, QuadbinQuerySourceOptions as _QuadbinQuerySourceOptions } from '../sources/index.js';
-import { WidgetBaseSourceProps } from './widget-base-source.js';
-import { WidgetQuerySource } from './widget-query-source.js';
-import { WidgetTableSource } from './widget-table-source.js';
-type WrappedSourceOptions<T> = Omit<T, 'filters'> & WidgetBaseSourceProps;
-/******************************************************************************
- * RESPONSE OBJECTS
- */
-type WidgetTableSourceResponse = {
-    widgetSource: WidgetTableSource;
-};
-type WidgetQuerySourceResponse = {
-    widgetSource: WidgetQuerySource;
-};
-export type VectorTableSourceResponse = WidgetTableSourceResponse & Awaited<ReturnType<typeof _vectorTableSource>>;
-export type VectorQuerySourceResponse = WidgetQuerySourceResponse & Awaited<ReturnType<typeof _vectorQuerySource>>;
-export type H3TableSourceResponse = WidgetTableSourceResponse & Awaited<ReturnType<typeof _h3TableSource>>;
-export type H3QuerySourceResponse = WidgetQuerySourceResponse & Awaited<ReturnType<typeof _h3QuerySource>>;
-export type QuadbinTableSourceResponse = WidgetTableSourceResponse & Awaited<ReturnType<typeof _quadbinTableSource>>;
-export type QuadbinQuerySourceResponse = WidgetQuerySourceResponse & Awaited<ReturnType<typeof _quadbinQuerySource>>;
-/******************************************************************************
- * VECTOR SOURCES
- */
-export type VectorTableSourceOptions = WrappedSourceOptions<_VectorTableSourceOptions>;
-export type VectorQuerySourceOptions = WrappedSourceOptions<_VectorQuerySourceOptions>;
-/** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export declare function vectorTableSource(props: VectorTableSourceOptions): Promise<VectorTableSourceResponse>;
-/** Wrapper adding Widget API support to [vectorQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export declare function vectorQuerySource(props: VectorQuerySourceOptions): Promise<VectorQuerySourceResponse>;
-/******************************************************************************
- * H3 SOURCES
- */
-export type H3TableSourceOptions = WrappedSourceOptions<_H3TableSourceOptions>;
-export type H3QuerySourceOptions = WrappedSourceOptions<_H3QuerySourceOptions>;
-/** Wrapper adding Widget API support to [h3TableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export declare function h3TableSource(props: H3TableSourceOptions): Promise<H3TableSourceResponse>;
-/** Wrapper adding Widget API support to [h3QuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export declare function h3QuerySource(props: H3QuerySourceOptions): Promise<H3QuerySourceResponse>;
-/******************************************************************************
- * QUADBIN SOURCES
- */
-export type QuadbinTableSourceOptions = WrappedSourceOptions<_QuadbinTableSourceOptions>;
-export type QuadbinQuerySourceOptions = WrappedSourceOptions<_QuadbinQuerySourceOptions>;
-/** Wrapper adding Widget API support to [quadbinTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export declare function quadbinTableSource(props: QuadbinTableSourceOptions & WidgetBaseSourceProps): Promise<QuadbinTableSourceResponse>;
-/** Wrapper adding Widget API support to [quadbinQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export declare function quadbinQuerySource(props: QuadbinQuerySourceOptions & WidgetBaseSourceProps): Promise<QuadbinQuerySourceResponse>;
-export {};

package/src/widget-sources/wrappers.ts

@@ -1,120 +0,0 @@
-import {
-  h3TableSource as _h3TableSource,
-  h3QuerySource as _h3QuerySource,
-  vectorTableSource as _vectorTableSource,
-  vectorQuerySource as _vectorQuerySource,
-  quadbinTableSource as _quadbinTableSource,
-  quadbinQuerySource as _quadbinQuerySource,
-  VectorTableSourceOptions as _VectorTableSourceOptions,
-  VectorQuerySourceOptions as _VectorQuerySourceOptions,
-  H3TableSourceOptions as _H3TableSourceOptions,
-  H3QuerySourceOptions as _H3QuerySourceOptions,
-  QuadbinTableSourceOptions as _QuadbinTableSourceOptions,
-  QuadbinQuerySourceOptions as _QuadbinQuerySourceOptions,
-} from '../sources/index.js';
-import {WidgetBaseSourceProps} from './widget-base-source.js';
-import {WidgetQuerySource} from './widget-query-source.js';
-import {WidgetTableSource} from './widget-table-source.js';
-
-type WrappedSourceOptions<T> = Omit<T, 'filters'> & WidgetBaseSourceProps;
-
-/******************************************************************************
- * RESPONSE OBJECTS
- */
-
-type WidgetTableSourceResponse = {widgetSource: WidgetTableSource};
-type WidgetQuerySourceResponse = {widgetSource: WidgetQuerySource};
-
-export type VectorTableSourceResponse = WidgetTableSourceResponse &
-  Awaited<ReturnType<typeof _vectorTableSource>>;
-export type VectorQuerySourceResponse = WidgetQuerySourceResponse &
-  Awaited<ReturnType<typeof _vectorQuerySource>>;
-
-export type H3TableSourceResponse = WidgetTableSourceResponse &
-  Awaited<ReturnType<typeof _h3TableSource>>;
-export type H3QuerySourceResponse = WidgetQuerySourceResponse &
-  Awaited<ReturnType<typeof _h3QuerySource>>;
-
-export type QuadbinTableSourceResponse = WidgetTableSourceResponse &
-  Awaited<ReturnType<typeof _quadbinTableSource>>;
-export type QuadbinQuerySourceResponse = WidgetQuerySourceResponse &
-  Awaited<ReturnType<typeof _quadbinQuerySource>>;
-
-/******************************************************************************
- * VECTOR SOURCES
- */
-
-export type VectorTableSourceOptions =
-  WrappedSourceOptions<_VectorTableSourceOptions>;
-
-export type VectorQuerySourceOptions =
-  WrappedSourceOptions<_VectorQuerySourceOptions>;
-
-/** Wrapper adding Widget API support to [vectorTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function vectorTableSource(
-  props: VectorTableSourceOptions
-): Promise<VectorTableSourceResponse> {
-  const response = await _vectorTableSource(props as _VectorTableSourceOptions);
-  return {...response, widgetSource: new WidgetTableSource(props)};
-}
-
-/** Wrapper adding Widget API support to [vectorQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function vectorQuerySource(
-  props: VectorQuerySourceOptions
-): Promise<VectorQuerySourceResponse> {
-  const response = await _vectorQuerySource(props as _VectorQuerySourceOptions);
-  return {...response, widgetSource: new WidgetQuerySource(props)};
-}
-
-/******************************************************************************
- * H3 SOURCES
- */
-
-export type H3TableSourceOptions = WrappedSourceOptions<_H3TableSourceOptions>;
-export type H3QuerySourceOptions = WrappedSourceOptions<_H3QuerySourceOptions>;
-
-/** Wrapper adding Widget API support to [h3TableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function h3TableSource(
-  props: H3TableSourceOptions
-): Promise<H3TableSourceResponse> {
-  const response = await _h3TableSource(props as _H3TableSourceOptions);
-  return {...response, widgetSource: new WidgetTableSource(props)};
-}
-
-/** Wrapper adding Widget API support to [h3QuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function h3QuerySource(
-  props: H3QuerySourceOptions
-): Promise<H3QuerySourceResponse> {
-  const response = await _h3QuerySource(props as _H3QuerySourceOptions);
-  return {...response, widgetSource: new WidgetQuerySource(props)};
-}
-
-/******************************************************************************
- * QUADBIN SOURCES
- */
-
-export type QuadbinTableSourceOptions =
-  WrappedSourceOptions<_QuadbinTableSourceOptions>;
-
-export type QuadbinQuerySourceOptions =
-  WrappedSourceOptions<_QuadbinQuerySourceOptions>;
-
-/** Wrapper adding Widget API support to [quadbinTableSource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function quadbinTableSource(
-  props: QuadbinTableSourceOptions & WidgetBaseSourceProps
-): Promise<QuadbinTableSourceResponse> {
-  const response = await _quadbinTableSource(
-    props as _QuadbinTableSourceOptions
-  );
-  return {...response, widgetSource: new WidgetTableSource(props)};
-}
-
-/** Wrapper adding Widget API support to [quadbinQuerySource](https://deck.gl/docs/api-reference/carto/data-sources). */
-export async function quadbinQuerySource(
-  props: QuadbinQuerySourceOptions & WidgetBaseSourceProps
-): Promise<QuadbinQuerySourceResponse> {
-  const response = await _quadbinQuerySource(
-    props as _QuadbinQuerySourceOptions
-  );
-  return {...response, widgetSource: new WidgetQuerySource(props)};
-}