@geolens/sdk 1.6.0 → 1.7.0

package/dist/client/types.gen.d.ts

@@ -132,12 +132,24 @@ export type AddDatasetsResponse = {
  * AdminApiKeyCreateRequest
  */
 export type AdminApiKeyCreateRequest = {
+    /**
+     * Expires At
+     *
+     * Optional expiry timestamp (RFC 3339, timezone-aware). Omit or null for a non-expiring key; expired keys stop authenticating.
+     */
+    expires_at?: string | null;
     /**
      * Name
      *
      * Human-readable label for the API key (e.g. 'CI pipeline', 'QGIS desktop').
      */
     name: string;
+    /**
+     * Scope
+     *
+     * Privilege scope (#875). 'full' impersonates the owner completely, the pre-existing behavior. 'read_only' authenticates GET, HEAD and OPTIONS requests only; any other method is refused with 403. A service-account key minted for an application is the usual case for 'read_only'.
+     */
+    scope?: 'full' | 'read_only';
     /**
      * User Id
      *
@@ -155,6 +167,12 @@ export type AdminApiKeyListItem = {
      * Timestamp when the key was created.
      */
     created_at: string;
+    /**
+     * Expires At
+     *
+     * Expiry timestamp; null means the key does not expire.
+     */
+    expires_at?: string | null;
     /**
      * Fingerprint
      *
@@ -185,6 +203,12 @@ export type AdminApiKeyListItem = {
      * Human-readable label.
      */
     name: string;
+    /**
+     * Scope
+     *
+     * Privilege scope: 'full' or 'read_only' (#875).
+     */
+    scope: string;
     /**
      * User Id
      *
@@ -493,10 +517,22 @@ export type AnalysisMaterializeRequest = {
      * Buffer distance in meters (buffer only)
      */
     distance_meters?: number | null;
+    /**
+     * Join Dataset Id
+     *
+     * Dataset to join against; each source feature gains a count of the features from it that intersect (spatial_join only)
+     */
+    join_dataset_id?: string | null;
+    /**
+     * Join Fields
+     *
+     * Columns to copy from the intersecting join feature, prefixed 'join_' in the output. Ties break on the lowest join-layer gid (spatial_join only)
+     */
+    join_fields?: Array<string> | null;
     /**
      * Mask
      *
-     * GeoJSON Polygon or MultiPolygon geometry in EPSG:4326 (clip only)
+     * GeoJSON Polygon or MultiPolygon geometry in EPSG:4326 (clip and select_by_location)
      */
     mask?: {
         [key: string]: unknown;
@@ -504,13 +540,13 @@ export type AnalysisMaterializeRequest = {
     /**
      * Mask Dataset Id
      *
-     * Polygon dataset whose unioned features form the clip mask (clip only; alternative to mask)
+     * Polygon dataset supplying the second layer: the area clipped to, selected against, or overlaid with. For clip and select_by_location it is the alternative to `mask`; for intersect it is REQUIRED and `mask` is rejected, because an overlay carries the second layer's attributes onto its output and a drawn polygon has none.
      */
     mask_dataset_id?: string | null;
     /**
      * Operation
      */
-    operation: 'buffer' | 'centroid' | 'clip' | 'dissolve';
+    operation: 'buffer' | 'centroid' | 'clip' | 'dissolve' | 'spatial_join' | 'measure' | 'select_by_location' | 'intersect';
     /**
      * Title
      */
@@ -546,10 +582,22 @@ export type AnalysisPreviewRequest = {
      * Buffer distance in meters (buffer only)
      */
     distance_meters?: number | null;
+    /**
+     * Join Dataset Id
+     *
+     * Dataset to join against; each source feature gains a count of the features from it that intersect (spatial_join only)
+     */
+    join_dataset_id?: string | null;
+    /**
+     * Join Fields
+     *
+     * Columns to copy from the intersecting join feature, prefixed 'join_' in the output. Ties break on the lowest join-layer gid (spatial_join only)
+     */
+    join_fields?: Array<string> | null;
     /**
      * Mask
      *
-     * GeoJSON Polygon or MultiPolygon geometry in EPSG:4326 (clip only)
+     * GeoJSON Polygon or MultiPolygon geometry in EPSG:4326 (clip and select_by_location)
      */
     mask?: {
         [key: string]: unknown;
@@ -557,13 +605,13 @@ export type AnalysisPreviewRequest = {
     /**
      * Mask Dataset Id
      *
-     * Polygon dataset whose unioned features form the clip mask (clip only; alternative to mask)
+     * Polygon dataset supplying the second layer: the area clipped to, selected against, or overlaid with. For clip and select_by_location it is the alternative to `mask`; for intersect it is REQUIRED and `mask` is rejected, because an overlay carries the second layer's attributes onto its output and a drawn polygon has none.
      */
     mask_dataset_id?: string | null;
     /**
      * Operation
      */
-    operation: 'buffer' | 'centroid' | 'clip';
+    operation: 'buffer' | 'centroid' | 'clip' | 'spatial_join' | 'measure' | 'select_by_location' | 'intersect';
 };
 /**
  * AnalysisPreviewResponse
@@ -585,6 +633,12 @@ export type AnalysisPreviewResponse = {
     geojson: {
         [key: string]: unknown;
     };
+    /**
+     * Match Count
+     *
+     * Exact total across the WHOLE source, not just the previewed features. What it counts is per-operation, so read it against the operation you sent rather than as one number: select_by_location gives the selected source features and intersect gives the output pieces, and for both of those it IS the output total; spatial_join gives intersecting source/join PAIRS, which is NOT the output total, because the join keeps every source row (use source_feature_count for that operation). Null for operations that report no such total, and when the count could not be computed within the query budget
+     */
+    match_count?: number | null;
     /**
      * Source Feature Count
      *
@@ -600,12 +654,24 @@ export type AnalysisPreviewResponse = {
  * ApiKeyCreateRequest
  */
 export type ApiKeyCreateRequest = {
+    /**
+     * Expires At
+     *
+     * Optional expiry timestamp (RFC 3339, timezone-aware). Omit or null for a non-expiring key; expired keys stop authenticating.
+     */
+    expires_at?: string | null;
     /**
      * Name
      *
      * Human-readable label for the API key
      */
     name: string;
+    /**
+     * Scope
+     *
+     * Privilege scope (#875). 'full' impersonates the owner completely, the pre-existing behavior. 'read_only' authenticates GET, HEAD and OPTIONS requests only; any other method is refused with 403.
+     */
+    scope?: 'full' | 'read_only';
 };
 /**
  * ApiKeyCreateResponse
@@ -615,6 +681,12 @@ export type ApiKeyCreateResponse = {
      * Created At
      */
     created_at: string;
+    /**
+     * Expires At
+     *
+     * Expiry timestamp; null means the key does not expire
+     */
+    expires_at?: string | null;
     /**
      * Fingerprint
      *
@@ -635,6 +707,12 @@ export type ApiKeyCreateResponse = {
      * Name
      */
     name: string;
+    /**
+     * Scope
+     *
+     * Privilege scope: 'full' or 'read_only' (#875)
+     */
+    scope: string;
 };
 /**
  * ApiKeyListItem
@@ -644,6 +722,12 @@ export type ApiKeyListItem = {
      * Created At
      */
     created_at: string;
+    /**
+     * Expires At
+     *
+     * Expiry timestamp; null means the key does not expire
+     */
+    expires_at?: string | null;
     /**
      * Fingerprint
      *
@@ -666,6 +750,12 @@ export type ApiKeyListItem = {
      * Name
      */
     name: string;
+    /**
+     * Scope
+     *
+     * Privilege scope: 'full' or 'read_only' (#875)
+     */
+    scope: string;
 };
 /**
  * ApiKeyListResponse
@@ -2865,10 +2955,14 @@ export type DatasetResponse = {
      * Start of temporal coverage
      */
     data_vintage_start?: string | null;
+    /**
+     * Provenance for an analysis output. Null for a dataset that was not derived, and also for a requester who cannot access the source dataset — the two are deliberately indistinguishable.
+     */
+    derived_from?: DerivedFromResponse | null;
     /**
      * Extent Bbox
      *
-     * Bounding box [minx, miny, maxx, maxy]
+     * Bounding box [west, south, east, north] per RFC 7946 §5.2. west > east on an antimeridian-crossing extent.
      */
     extent_bbox?: Array<number> | null;
     /**
@@ -3195,6 +3289,52 @@ export type DbfTruncationDetail = {
      */
     truncated: string;
 };
+/**
+ * DerivedFromResponse
+ *
+ * Provenance for an analysis output: what it came from, and how.
+ *
+ * fix(#765 review): declared as a model rather than ``dict[str, Any]``. The
+ * dict spelled itself into the checked-in OpenAPI as bare
+ * ``additionalProperties: true``, so both generated SDKs lost the shape — the
+ * TypeScript one degraded to an index signature and the Python one to an
+ * empty additional-properties container. The stable shape was documented in
+ * prose and mirrored by hand in the frontend types while the SDKs, which is
+ * where most consumers actually meet it, could not use it type-safely.
+ *
+ * ``params`` stays untyped on purpose: it is the operation's own parameter
+ * dict, so its keys differ per operation (``distance_meters`` for a buffer,
+ * ``mask_source``/``mask_dataset_id`` for a clip), and it is additionally
+ * REDACTED per requester — ``visible_derived_from`` drops any embedded
+ * dataset id the caller cannot see. A union of per-operation models would
+ * describe a shape the redaction is free to punch holes in.
+ */
+export type DerivedFromResponse = {
+    /**
+     * Created At
+     */
+    created_at: string;
+    /**
+     * Dataset Id
+     *
+     * The dataset this one was derived from
+     */
+    dataset_id: string;
+    /**
+     * Operation
+     *
+     * Analysis operation that produced it
+     */
+    operation: string;
+    /**
+     * Params
+     *
+     * Operation parameters, minus any dataset reference the requester cannot access
+     */
+    params: {
+        [key: string]: unknown;
+    };
+};
 /**
  * DetectEmbeddingDimsResponse
  *
@@ -4291,7 +4431,7 @@ export type JobStatusResponse = {
     /**
      * Warnings
      */
-    warnings?: Array<ReservedRenameWarning | DbfTruncationCollisionWarning>;
+    warnings?: Array<ReservedRenameWarning | DbfTruncationCollisionWarning | MercatorClipWarning>;
 };
 /**
  * KeywordCreate
@@ -5521,6 +5661,10 @@ export type MapSummaryResponse = {
      * Name
      */
     name: string;
+    /**
+     * Thumbnail Updated At
+     */
+    thumbnail_updated_at?: string | null;
     /**
      * Thumbnail Url
      */
@@ -5622,6 +5766,44 @@ export type MapUpdate = {
  * MapVisibility
  */
 export type MapVisibility = 'private' | 'internal' | 'public';
+/**
+ * MercatorClipDetail
+ *
+ * fix(#888): how much geometry the Web Mercator clamp destroyed.
+ *
+ * The clamp is a box, not a latitude cutoff: longitude -180 to 180 and
+ * latitude -85.06 to 85.06. Either bound can be the one that cost the user
+ * geometry, so clients must not present this as a latitude-only problem
+ * (fix(#899 codex r1)).
+ *
+ * ``dropped_features`` lost their geometry entirely (a valid point at lat
+ * -89.95 becomes ``MULTIPOINT EMPTY``); ``clipped_features`` survived in
+ * reduced form.
+ */
+export type MercatorClipDetail = {
+    /**
+     * Clip Skipped
+     */
+    clip_skipped?: boolean;
+    /**
+     * Clipped Features
+     */
+    clipped_features: number;
+    /**
+     * Dropped Features
+     */
+    dropped_features: number;
+};
+/**
+ * MercatorClipWarning
+ */
+export type MercatorClipWarning = {
+    details: MercatorClipDetail;
+    /**
+     * Kind
+     */
+    kind: 'mercator_clip';
+};
 /**
  * MetadataAssistRequest
  *
@@ -7171,12 +7353,34 @@ export type RasterPreviewResponse = {
 };
 /**
  * RasterTileToken
+ *
+ * A raster tile template, signed like its vector sibling.
+ *
+ * fix(#688): the raster shape used to carry no signature at all, so a client
+ * following the API contract literally received an *unauthenticated* template
+ * for a private raster. MapLibre issues the tile image requests itself and
+ * attaches no `X-Api-Key`, so an API-key-only client could not render one —
+ * the workarounds were `setTransformRequest` (not available to every consumer)
+ * or `?api_key=` in the tile URL, which puts a non-expiring unscoped
+ * credential into tile URLs, server logs, and saved client project files.
+ *
+ * `tile_url` now arrives with `sig`/`exp`/`scope` already in its query string,
+ * so the template is self-sufficient and expires. The three are also returned
+ * as fields, mirroring `VectorTileToken`, for clients that rebuild the URL.
  */
 export type RasterTileToken = {
     /**
      * Bounds
      */
     bounds: Array<number> | null;
+    /**
+     * Exp
+     */
+    exp: number;
+    /**
+     * Expires In
+     */
+    expires_in: number;
     /**
      * Format
      */
@@ -7193,6 +7397,14 @@ export type RasterTileToken = {
      * Minzoom
      */
     minzoom: number;
+    /**
+     * Scope
+     */
+    scope: string;
+    /**
+     * Sig
+     */
+    sig: string;
     /**
      * Tile Size
      */
@@ -24342,46 +24554,6 @@ export type ClusterTileEndpointTilesClustersTablePathZxyPbfGetResponses = {
      */
     200: unknown;
 };
-export type RasterAuthCheckTilesRasterAuthCheckGetData = {
-    body?: never;
-    path?: never;
-    query: {
-        /**
-         * Dataset Id
-         */
-        dataset_id: string;
-    };
-    url: '/tiles/raster-auth-check/';
-};
-export type RasterAuthCheckTilesRasterAuthCheckGetErrors = {
-    /**
-     * Bad request — invalid query parameters or payload
-     */
-    400: ProblemDetail;
-    /**
-     * Not found
-     */
-    404: ProblemDetail;
-    /**
-     * Validation error
-     */
-    422: ProblemDetail;
-    /**
-     * Internal server error
-     */
-    500: ProblemDetail;
-    /**
-     * Service unavailable — the database could not serve the request
-     */
-    503: ProblemDetail;
-};
-export type RasterAuthCheckTilesRasterAuthCheckGetError = RasterAuthCheckTilesRasterAuthCheckGetErrors[keyof RasterAuthCheckTilesRasterAuthCheckGetErrors];
-export type RasterAuthCheckTilesRasterAuthCheckGetResponses = {
-    /**
-     * Successful Response
-     */
-    200: unknown;
-};
 export type RasterTileProxyTilesRasterProxyDatasetIdZxyFmtGetData = {
     body?: never;
     path: {