@geolens/sdk 1.18.1 → 1.19.0

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

@@ -4,7 +4,7 @@ export type ClientOptions = {
 /**
  * AIAvailabilityResponse
  *
- * Public-safe AI readiness signal (builder-audit #338 P1-11).
+ * Public-safe AI readiness signal (#338).
  *
  * Carries a single boolean and intentionally exposes NO provider name, model,
  * or key detail — it is readable by any non-admin editor holding
@@ -1051,6 +1051,28 @@ export type AuditLogResponse = {
      */
     created_at: string;
 };
+/**
+ * BackfillEstimate
+ *
+ * How long each backfill action should take, before starting one.
+ *
+ * Both figures come from the throughput of the most recent completed run, so
+ * they describe this deployment's own provider rather than a generic rate.
+ */
+export type BackfillEstimate = {
+    /**
+     * Missing Seconds
+     *
+     * Estimated seconds to embed the records that lack a usable vector.
+     */
+    missing_seconds: number;
+    /**
+     * All Seconds
+     *
+     * Estimated seconds to regenerate every record in the catalog.
+     */
+    all_seconds: number;
+};
 /**
  * BackfillResponse
  *
@@ -1074,6 +1096,98 @@ export type BackfillResponse = {
      */
     status: string;
 };
+/**
+ * BackfillRunProgress
+ *
+ * The embedding backfill run currently holding the single run slot.
+ */
+export type BackfillRunProgress = {
+    /**
+     * Job Id
+     *
+     * Identifier of the run in flight.
+     */
+    job_id: string;
+    /**
+     * Status
+     *
+     * Job status: 'pending' or 'running'.
+     */
+    status: string;
+    /**
+     * Records Processed
+     *
+     * Records the run has embedded so far.
+     */
+    records_processed: number;
+    /**
+     * Records Total
+     *
+     * Records the run will embed in total. Null until the run has selected its records.
+     */
+    records_total?: number | null;
+    /**
+     * Started At
+     *
+     * When a worker picked the run up.
+     */
+    started_at?: string | null;
+    /**
+     * Heartbeat At
+     *
+     * Last time the running worker renewed its lease.
+     */
+    heartbeat_at?: string | null;
+};
+/**
+ * BackfillRunSummary
+ *
+ * One finished embedding backfill run.
+ */
+export type BackfillRunSummary = {
+    /**
+     * Job Id
+     *
+     * Identifier of the finished run.
+     */
+    job_id: string;
+    /**
+     * Status
+     *
+     * How the run ended: 'complete', 'failed' or 'cancelled'.
+     */
+    status: string;
+    /**
+     * Started At
+     *
+     * When a worker picked the run up.
+     */
+    started_at?: string | null;
+    /**
+     * Finished At
+     *
+     * When the run reached its final status.
+     */
+    finished_at?: string | null;
+    /**
+     * Records Processed
+     *
+     * Records the run embedded.
+     */
+    records_processed: number;
+    /**
+     * Records Failed
+     *
+     * Records the run could not embed, when the run recorded a count. A finished run with a non-zero figure here left coverage gaps.
+     */
+    records_failed?: number | null;
+    /**
+     * Error Code
+     *
+     * Short code identifying how a run failed, when it failed.
+     */
+    error_code?: string | null;
+};
 /**
  * BasemapConfig
  */
@@ -1119,13 +1233,13 @@ export type BasemapConfig = {
     /**
      * Sublayer Overrides
      *
-     * Per-sublayer style overrides keyed by semantic sublayer ID (e.g. 'road', 'boundary', 'building'). Key set is opaque — unknown future sublayer IDs are accepted without rejection. See CONTEXT.md D-01.
+     * Per-sublayer style overrides keyed by semantic sublayer ID (e.g. 'road', 'boundary', 'building'). The key set is opaque: a sublayer ID this release does not know is accepted and stored rather than rejected.
      */
     sublayer_overrides?: {
         [key: string]: SublayerOverride;
     } | null;
     /**
-     * Whether the basemap renders above ('top') or below ('bottom', default) the data layers. null/undefined loads as 'bottom' on the client. Phase 1051 UX-03 (jsonb-additive, no migration).
+     * Whether the basemap renders above ('top') or below ('bottom', default) the data layers. null/undefined loads as 'bottom' on the client.
      */
     basemap_position?: BasemapPosition | null;
     /**
@@ -1379,6 +1493,10 @@ export type BulkDeleteResultItem = {
      * Detail
      */
     detail?: string | null;
+    /**
+     * Code
+     */
+    code?: string | null;
 };
 /**
  * BulkRegisterItem
@@ -2175,7 +2293,7 @@ export type CommitRequest = {
     /**
      * Token
      *
-     * Optional confirmation token returned by the preview step. Required for some workflows.
+     * Optional auth token for a protected remote service, read only when the job imports a service layer (WFS, OGC API Features, or ArcGIS). At most 1000 characters. Never persisted to the database. Ignored on file-upload jobs. Deprecated: use the auth object with method bearer.
      */
     token?: string | null;
     /**
@@ -2236,6 +2354,12 @@ export type CommitRequest = {
      * Structured credential for a protected service. Mutually exclusive with the token field.
      */
     auth?: ServiceAuthRequest | null;
+    /**
+     * Strict Cog
+     *
+     * Raster only: reject a non-COG TIFF instead of converting it. False (the default) converts the source to a COG during ingest. True fails the job when the source is not already a compliant COG, and cannot be combined with resampling, nodata_override, srid_override or a compression other than the default DEFLATE: each of those is applied by a conversion, so the commit is refused with a 422 naming the fields that clash.
+     */
+    strict_cog?: boolean;
 };
 /**
  * CommitResponse
@@ -3114,7 +3238,7 @@ export type DatasetRelationshipCreate = {
 /**
  * DatasetRelationshipListResponse
  *
- * Paginated list envelope for dataset FK relationships (GAP-033).
+ * Paginated list envelope for dataset FK relationships.
  *
  * Mirrors the ``{<entity>: [...], total: int}`` convention used by every other
  * paginated list endpoint (e.g. AttributeMetadataListResponse,
@@ -4237,6 +4361,20 @@ export type EmbeddingStatsResponse = {
      * Embedding coverage as a percentage (0-100).
      */
     coverage_percent: number;
+    /**
+     * The backfill run in flight, or null when none is running.
+     */
+    current_run?: BackfillRunProgress | null;
+    /**
+     * Recent Runs
+     *
+     * The most recent finished backfill runs, newest first.
+     */
+    recent_runs?: Array<BackfillRunSummary>;
+    /**
+     * Expected duration of each backfill action, or null until one run has completed and measured this deployment's throughput.
+     */
+    estimate?: BackfillEstimate | null;
 };
 /**
  * EnterpriseTabsResponse
@@ -4771,7 +4909,7 @@ export type JobStatusResponse = {
     /**
      * Current Step
      */
-    current_step?: 'queued' | 'validating' | 'ogr2ogr' | 'finalize' | 'complete' | 'cog_convert' | 'quicklook' | 'analyzing' | 'registering' | null;
+    current_step?: 'queued' | 'downloading' | 'validating' | 'ogr2ogr' | 'finalize' | 'complete' | 'cog_convert' | 'quicklook' | 'analyzing' | 'registering' | null;
     /**
      * Rows Processed
      */
@@ -4978,7 +5116,7 @@ export type LayerInfo = {
     /**
      * Kind
      *
-     * Backend-classified layer kind. 'vector' = point/line/polygon feature data. 'raster' = imagery/coverage. Per Phase 1057 CLASS-07 D-09. Classification rule: raster IFF geometry_type contains 'raster', adapter is STAC, or layer has coverage_format/bands/mediaType:image*. Everything else (including geometry_type=None after D-05 ogrinfo drop) defaults to 'vector'.
+     * Backend-classified layer kind. 'vector' = point/line/polygon feature data. 'raster' = imagery/coverage. Classified as 'raster' when geometry_type contains 'raster', the adapter is STAC, the layer declares coverage_format or bands, or one of its links has a media type of image*. Everything else, including a layer with no geometry_type at all, defaults to 'vector'.
      */
     kind?: 'vector' | 'raster';
 };
@@ -5756,6 +5894,10 @@ export type MapLayerResponse = {
      * Tile Version
      */
     tile_version?: number | null;
+    /**
+     * Publication Version
+     */
+    publication_version?: number | null;
     /**
      * Dataset Visibility
      */
@@ -5902,7 +6044,7 @@ export type MapSpriteEntry = {
 /**
  * MapStyleImportRequest
  *
- * Typed request body for POST /maps/import — API-01 / M-05.
+ * Typed request body for POST /maps/import.
  *
  * Mirrors the top-level keys of the MapLibre Style Specification that
  * ``parse_maplibre_style_import`` actually reads. ``extra="allow"`` keeps
@@ -6173,7 +6315,7 @@ export type MapUpdate = {
     /**
      * Legend Title
      *
-     * Custom map-level legend title. Null/empty leaves the legend without a heading override (ENH-06).
+     * Custom map-level legend title. Null or empty leaves the legend without a heading override. At most 120 characters.
      */
     legend_title?: string | null;
 };
@@ -6235,7 +6377,7 @@ export type MetadataAssistRequest = {
 /**
  * NotificationStatusResponse
  *
- * Response for GET /settings/notifications/status/ (NOTIF-05 / NOTIF-06).
+ * Response for GET /settings/notifications/status/.
  *
  * Returns only boolean presence flags — never a secret value (SMTP password,
  * webhook URL, or webhook secret).
@@ -6266,8 +6408,7 @@ export type NotificationStatusResponse = {
  * Per-channel result from POST /settings/notifications/test/.
  *
  * The ``error`` field contains only the exception type name and a short
- * safe message — never the SMTP password, webhook URL, or webhook secret
- * (T-1229-09 / NOTIF-05).
+ * safe message — never the SMTP password, webhook URL, or webhook secret.
  */
 export type NotificationTestChannelResult = {
     /**
@@ -6292,11 +6433,11 @@ export type NotificationTestChannelResult = {
 /**
  * NotificationTestResponse
  *
- * Response for POST /settings/notifications/test/ (NOTIF-06).
+ * Response for POST /settings/notifications/test/.
  *
  * Always returns HTTP 200 — a channel delivery failure is captured in the
  * per-channel ``channels`` list rather than as a 5xx. Never contains secret
- * values (T-1229-09 / NOTIF-05).
+ * values.
  */
 export type NotificationTestResponse = {
     /**
@@ -6472,10 +6613,10 @@ export type OAuthProviderPublic = {
  * The 3 non-secret SAML fields (``idp_entity_id``, ``idp_sso_url``,
  * ``sp_entity_id``) ARE exposed so the admin UI can display them.
  *
- * Pitfall 11 interaction: those 3 fields are declared with ``deferred=True``
- * on the OAuth ORM model so community DBs (which lack the columns) do not
- * crash on SELECT. Pydantic's ``from_attributes=True`` would normally trigger
- * an implicit deferred load on attribute access, which fails under FastAPI's
+ * Those 3 fields are declared with ``deferred=True`` on the OAuth ORM
+ * model so community DBs (which lack the columns) do not crash on
+ * SELECT. Pydantic's ``from_attributes=True`` would normally trigger an
+ * implicit deferred load on attribute access, which fails under FastAPI's
  * async context with ``MissingGreenlet``. The ``model_validator(mode="before")``
  * below reads the SAML fields directly from ``obj.__dict__`` so unloaded
  * attributes default to None instead of triggering IO. SAML admin endpoints
@@ -7247,7 +7388,7 @@ export type OgcRecordResponse = {
 /**
  * OgImageUploadRequest
  *
- * JSON body for PUT /maps/{map_id}/og-image/ (SHARE-08 Path A).
+ * JSON body for PUT /maps/{map_id}/og-image/.
  *
  * Accepts a base64 data URI up to 750 KB (as a string). This generous
  * ceiling accommodates a 1200x630 JPEG at quality 0.85, which encodes
@@ -7257,7 +7398,7 @@ export type OgcRecordResponse = {
  * empty/clearly-malformed URIs without false-positives.
  * - ``max_length=750_000``: ~562 KB decoded — generous for 1200x630 JPEG.
  * DO NOT raise ThumbnailUploadRequest.max_length to match this value;
- * the 100KB thumbnail cap is a locked contract (Phase 254 / D-03).
+ * the 100KB thumbnail cap is a locked contract.
  */
 export type OgImageUploadRequest = {
     /**
@@ -9301,6 +9442,16 @@ export type StacConnectRequest = {
      * STAC API root URL to connect to.
      */
     url: string;
+    /**
+     * Token
+     *
+     * Optional auth token for a protected STAC catalog. Deprecated: use the auth object with method bearer.
+     */
+    token?: string | null;
+    /**
+     * Structured credential for a protected service. Mutually exclusive with the token field.
+     */
+    auth?: ServiceAuthRequest | null;
 };
 /**
  * StacConnectResponse
@@ -9456,6 +9607,12 @@ export type StacImportRequest = {
      * Visibility for imported datasets.
      */
     visibility?: 'private' | 'restricted' | 'internal' | 'public';
+    /**
+     * Catalog Auth Required
+     *
+     * Whether browsing this catalog needed a credential. Set it when the search that produced these items carried one, so the first refresh asks for a credential instead of failing anonymously.
+     */
+    catalog_auth_required?: boolean;
 };
 /**
  * StacImportResponse
@@ -9909,6 +10066,16 @@ export type StacSearchRequest = {
      * Maximum items to return.
      */
     limit?: number;
+    /**
+     * Token
+     *
+     * Optional auth token for a protected STAC catalog. Deprecated: use the auth object with method bearer.
+     */
+    token?: string | null;
+    /**
+     * Structured credential for a protected service. Mutually exclusive with the token field.
+     */
+    auth?: ServiceAuthRequest | null;
 };
 /**
  * StacSearchResponse
@@ -10025,12 +10192,12 @@ export type StatusUpdateResponse = {
  * validation time (Pydantic ``ge``/``le`` constraints).
  *
  * The key set of ``BasemapConfig.sublayer_overrides`` is treated as opaque
- * (forward-compatible with future sublayer IDs) — see CONTEXT.md D-01.
+ * (forward-compatible with future sublayer IDs).
  *
  * Security:
- * extra="forbid" locks the D-14 scope guardrail: unknown style axes such
- * as dash patterns, line caps, halo blur, and text-font are rejected at
- * validation time (T-1059A-03).
+ * extra="forbid" locks the scope guardrail: unknown style axes such as
+ * dash patterns, line caps, halo blur, and text-font are rejected at
+ * validation time.
  */
 export type SublayerOverride = {
     /**
@@ -10072,7 +10239,7 @@ export type SublayerOverride = {
     /**
      * Opacity
      *
-     * Per-sublayer opacity (0-1), or null to use the basemap default. Composes on top of BasemapConfig.opacity (the whole-basemap master opacity): the rendered opacity is override.opacity * master_opacity (builder-audit #338 CORR-01). The UI opacity slider in BasemapSublayerEditorScene persists through this field: MapBuilderPage.handleSublayerOpacityChange -> setBasemapSublayerOpacity -> updateBasemapSublayerOverride writes config.sublayer_overrides[key].opacity.
+     * Per-sublayer opacity (0-1), or null to use the basemap default. Composes on top of BasemapConfig.opacity (the whole-basemap master opacity): the rendered opacity is override.opacity * master_opacity (#338). The UI opacity slider in BasemapSublayerEditorScene persists through this field: MapBuilderPage.handleSublayerOpacityChange -> setBasemapSublayerOpacity -> updateBasemapSublayerOverride writes config.sublayer_overrides[key].opacity.
      */
     opacity?: number | null;
 };
@@ -10135,9 +10302,9 @@ export type TerrainConfig = {
  * JSON body for PUT /maps/{map_id}/thumbnail/.
  *
  * Replaces a previous text/plain body shape that openapi-python-client
- * could not parse (would silently skip endpoint). See Phase 254 / SDK-01.
+ * could not parse (would silently skip endpoint).
  *
- * Phase 254 IN-02: ``data_uri`` carries explicit length bounds so
+ * ``data_uri`` carries explicit length bounds so
  * Pydantic surfaces a 422 with field-level detail (better SDK-consumer
  * UX than a generic 400) and the OpenAPI schema documents the limit.
  * The router still validates the ``data:image/`` prefix and base64
@@ -10365,7 +10532,7 @@ export type UploadResponse = {
     /**
      * Status
      *
-     * Initial job status. Always 'pending' on creation.
+     * Initial job status. 'pending' means the file is staged and ready to preview; 'running' means the server is still fetching it, as it is for a URL import.
      */
     status?: string;
     /**
@@ -14981,7 +15148,7 @@ export type GetCollectionItemsCollectionsDatasetIdItemsGetData = {
         /**
          * After Gid
          *
-         * Keyset cursor: returns features with gid > after_gid. Phase 269 H-24 primary pagination path; use the rel=next link for follow-up pages.
+         * Keyset cursor: returns features with gid > after_gid. The preferred pagination path; use the rel=next link for follow-up pages.
          */
         after_gid?: number | null;
         /**
@@ -15029,7 +15196,7 @@ export type GetCollectionItemsCollectionsDatasetIdItemsGetData = {
 };
 export type GetCollectionItemsCollectionsDatasetIdItemsGetErrors = {
     /**
-     * Bad request — invalid query parameters or payload
+     * Bad request. Either a query parameter is invalid, or the `filter` was refused. A CQL2 filter is refused when it names a queryable this collection does not publish, or uses an operator this server does not implement; when it is longer than 10,000 characters; when it nests deeper than the parser will walk; or when it expands to more than 1,000 bound parameters. The last two are resource bounds rather than syntax errors, so the filter can be valid CQL2 and still be declined: an `IN` list reaches the parameter ceiling well before the character limit, since `render_postcompile` expands it to one parameter per member. Both are answered deterministically, so a client that splits the filter and pages the results gets the same rows.
      */
     400: ProblemDetail;
     /**
@@ -17112,7 +17279,7 @@ export type ListFeaturesDatasetsDatasetIdFeaturesGetData = {
         /**
          * Offset
          *
-         * Legacy offset-based pagination. Phase 269 H-24 lowered the max limit to 200 from 1000.
+         * Legacy offset-based pagination. The companion limit is capped at 200 per page, and a high offset is costly to serve.
          */
         offset?: number;
         /**
@@ -18301,7 +18468,7 @@ export type ListDatasetRelationshipsDatasetsDatasetIdRelationshipsGetData = {
         /**
          * Limit
          *
-         * Maximum number of relationships to return (PERF-N16).
+         * Maximum number of relationships to return. Capped at 1000.
          */
         limit?: number;
     };
@@ -19554,7 +19721,7 @@ export type DiscoverTablesIngestDiscoverGetData = {
         /**
          * Limit
          *
-         * Maximum number of tables to return (PERF-11 bound).
+         * Maximum number of tables to return. Capped at 5000.
          */
         limit?: number;
     };
@@ -25700,7 +25867,7 @@ export type GetCollectionItemsStacCollectionsCollectionIdItemsGetData = {
         /**
          * Offset
          *
-         * Legacy offset-based pagination. Phase 269 H-24 lowered the max limit to 200 and recommends keyset cursors via the rel=next link for deep paging.
+         * Legacy offset-based pagination. The page size is capped at 200; the rel=next link advances one page at a time, and a high offset is costly to serve.
          */
         offset?: number;
     };
@@ -25893,7 +26060,7 @@ export type SearchGetStacSearchGetData = {
         /**
          * Intersects
          *
-         * GeoJSON geometry for spatial intersection. SEC-FU-05 (sec-audit-20260519.md): max_length=10000 caps a multi-megabyte GeoJSON DoS-amplifier — fits ~150-vertex polygons at 2-decimal-place lat/lon coordinates.
+         * GeoJSON geometry for spatial intersection. At most 10000 characters, which fits a polygon of several hundred vertices at 2-decimal-place lat/lon coordinates.
          */
         intersects?: string | null;
         /**
@@ -25905,7 +26072,7 @@ export type SearchGetStacSearchGetData = {
         /**
          * Offset
          *
-         * Legacy offset-based pagination. Phase 269 H-24 lowered the max limit to 200 from 1000 to bound deep-paging cost.
+         * Legacy offset-based pagination. The page size is capped at 200; a high offset is costly to serve.
          */
         offset?: number;
     };