@geolens/sdk 1.17.0 → 1.18.1

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.
@@ -405,6 +405,24 @@ export type AdminJobResponse = {
405
405
  */
406
406
  created_at: string;
407
407
  };
408
+ /**
409
+ * AdminPasswordReset
410
+ *
411
+ * Request body for POST /admin/users/{user_id}/reset-password/.
412
+ *
413
+ * Single-purpose for the same reason as SamlToLocalConversion above: the
414
+ * generic UserUpdate schema has no password field, so an admin-set password
415
+ * lands as its own audited action ('user.password_reset') rather than
416
+ * disappearing into 'user.update'.
417
+ */
418
+ export type AdminPasswordReset = {
419
+ /**
420
+ * Password
421
+ *
422
+ * Replacement password for the account (policy: min 12 chars, 3+ character classes, at most 72 bytes UTF-8). The user can change this after their next login.
423
+ */
424
+ password: string;
425
+ };
408
426
  /**
409
427
  * AdminShareTokenListResponse
410
428
  */
@@ -472,7 +490,7 @@ export type AdminUserCreate = {
472
490
  /**
473
491
  * Password
474
492
  *
475
- * Initial password (policy: min 12 chars, 3+ character classes). The user can change this after first login.
493
+ * Initial password (policy: min 12 chars, 3+ character classes, at most 72 bytes UTF-8). The user can change this after first login.
476
494
  */
477
495
  password: string;
478
496
  /**
@@ -806,6 +824,56 @@ export type ApproveRequest = {
806
824
  */
807
825
  role: string;
808
826
  };
827
+ /**
828
+ * ArcGISSignInRequest
829
+ *
830
+ * Portal address plus the credentials one generateToken call needs.
831
+ *
832
+ * No character policy on the two credential fields, deliberately. They are
833
+ * form-encoded into the outbound body, which percent-escapes every value,
834
+ * so neither a control character nor a separator can smuggle a second field
835
+ * into the request the way one can into a header line. The length bounds
836
+ * are here to keep an absurd body from reaching the portal at all.
837
+ */
838
+ export type ArcGisSignInRequest = {
839
+ /**
840
+ * Portal Url
841
+ *
842
+ * ArcGIS portal URL, for example https://your-org.maps.arcgis.com. The /sharing/rest base is accepted too.
843
+ */
844
+ portal_url: string;
845
+ /**
846
+ * Username
847
+ *
848
+ * ArcGIS account name to sign in with.
849
+ */
850
+ username: string;
851
+ /**
852
+ * Password
853
+ *
854
+ * Password for that ArcGIS account.
855
+ */
856
+ password: string;
857
+ };
858
+ /**
859
+ * ArcGISSignInResponse
860
+ *
861
+ * The minted portal token and nothing else about the account.
862
+ */
863
+ export type ArcGisSignInResponse = {
864
+ /**
865
+ * Token
866
+ *
867
+ * Short-lived ArcGIS portal token. Use it as the `token` field on probe, preview, commit and refresh.
868
+ */
869
+ token: string;
870
+ /**
871
+ * Expires At
872
+ *
873
+ * UTC instant at which the portal stops accepting the token.
874
+ */
875
+ expires_at: string;
876
+ };
809
877
  /**
810
878
  * AttributeMetadataListResponse
811
879
  */
@@ -1480,7 +1548,7 @@ export type ChangePasswordRequest = {
1480
1548
  /**
1481
1549
  * New Password
1482
1550
  *
1483
- * New password (policy: min 12 chars, 3+ character classes: lowercase, uppercase, digits, symbols). The min_length=8 here is a schema floor; the runtime validator enforces the full policy.
1551
+ * New password (policy: min 12 chars, 3+ character classes: lowercase, uppercase, digits, symbols; at most 72 bytes UTF-8). The min_length=8 here is a schema floor; the runtime validator enforces the full policy.
1484
1552
  */
1485
1553
  new_password: string;
1486
1554
  };
@@ -2164,6 +2232,10 @@ export type CommitRequest = {
2164
2232
  * CSV/Excel only: name of the WKT geometry column (alternative to x_column/y_column).
2165
2233
  */
2166
2234
  geom_column?: string | null;
2235
+ /**
2236
+ * Structured credential for a protected service. Mutually exclusive with the token field.
2237
+ */
2238
+ auth?: ServiceAuthRequest | null;
2167
2239
  };
2168
2240
  /**
2169
2241
  * CommitResponse
@@ -2847,9 +2919,13 @@ export type DatasetRefreshRequest = {
2847
2919
  /**
2848
2920
  * Token
2849
2921
  *
2850
- * Transient credential for a protected service. Used for this refresh only and never persisted: it is handed to the worker through a single-use, short-lived reference and is gone once claimed. A retry needs a new token.
2922
+ * Transient credential for a protected service. Used for this refresh only and never persisted: it is handed to the worker through a single-use, short-lived reference and is gone once claimed. A retry needs a new token. Deprecated: use the auth object with method bearer.
2851
2923
  */
2852
2924
  token?: string | null;
2925
+ /**
2926
+ * Structured credential for a protected service. Mutually exclusive with the token field.
2927
+ */
2928
+ auth?: ServiceAuthRequest | null;
2853
2929
  };
2854
2930
  /**
2855
2931
  * DatasetRefreshResponse
@@ -3283,7 +3359,7 @@ export type DatasetResponse = {
3283
3359
  /**
3284
3360
  * Source Health Detail
3285
3361
  *
3286
- * Why the origin is not healthy, as one of a fixed set of GeoLens codes: blocked_by_policy, item_withdrawn, network_error, not_found, server_error, timeout, unauthorized, unexpected_status. Null when healthy or never probed. Never provider text, a URL, or a response body — nothing the origin sent is stored here.
3362
+ * Why the origin is not healthy, as one of a fixed set of GeoLens codes: auth_required, blocked_by_policy, item_withdrawn, network_error, not_found, server_error, timeout, unauthorized, unexpected_status. Null when healthy or never probed. Never provider text, a URL, or a response body — nothing the origin sent is stored here.
3287
3363
  */
3288
3364
  source_health_detail?: string | null;
3289
3365
  /**
@@ -5139,6 +5215,10 @@ export type ManifestSource = {
5139
5215
  * Layer
5140
5216
  */
5141
5217
  layer?: string | null;
5218
+ /**
5219
+ * Checksum
5220
+ */
5221
+ checksum?: string | null;
5142
5222
  };
5143
5223
  /**
5144
5224
  * MapAccessResponse
@@ -5940,6 +6020,12 @@ export type MapStyleImportSummary = {
5940
6020
  * Warnings
5941
6021
  */
5942
6022
  warnings?: Array<MapStyleImportWarning>;
6023
+ /**
6024
+ * Warnings Truncated
6025
+ *
6026
+ * Warnings produced beyond the reported list
6027
+ */
6028
+ warnings_truncated?: number;
5943
6029
  };
5944
6030
  /**
5945
6031
  * MapStyleImportWarning
@@ -6828,6 +6914,41 @@ export type OgcLink = {
6828
6914
  */
6829
6915
  title?: string | null;
6830
6916
  };
6917
+ /**
6918
+ * OGCRasterBand
6919
+ *
6920
+ * One entry in the raster:bands STAC extension array.
6921
+ *
6922
+ * fix(#1805 review round 3 P2): matches the shape service_records.py
6923
+ * actually serializes per band. `statistics` matches the normalized
6924
+ * band_info shape core/raster_bands.py (introduced by #1803, the raster
6925
+ * lifecycle PR) produces on read; keep this in sync if that PR changes
6926
+ * the per-band keys.
6927
+ */
6928
+ export type OgcRasterBand = {
6929
+ /**
6930
+ * Name
6931
+ */
6932
+ name?: string | null;
6933
+ /**
6934
+ * Data Type
6935
+ */
6936
+ data_type?: string | null;
6937
+ /**
6938
+ * Nodata
6939
+ */
6940
+ nodata?: string | number | number | null;
6941
+ /**
6942
+ * Statistics
6943
+ */
6944
+ statistics?: {
6945
+ [key: string]: unknown;
6946
+ } | null;
6947
+ /**
6948
+ * Description
6949
+ */
6950
+ description?: string | null;
6951
+ };
6831
6952
  /**
6832
6953
  * OGCRecordLink
6833
6954
  *
@@ -7033,6 +7154,14 @@ export type OgcRecordProperties = {
7033
7154
  * Gsd
7034
7155
  */
7035
7156
  gsd?: number | null;
7157
+ /**
7158
+ * Res X
7159
+ */
7160
+ res_x?: number | null;
7161
+ /**
7162
+ * Res Y
7163
+ */
7164
+ res_y?: number | null;
7036
7165
  /**
7037
7166
  * Crs Is Geographic
7038
7167
  *
@@ -7051,6 +7180,23 @@ export type OgcRecordProperties = {
7051
7180
  * Dataset Count
7052
7181
  */
7053
7182
  dataset_count?: number | null;
7183
+ /**
7184
+ * Proj:Code
7185
+ */
7186
+ 'proj:code'?: string | null;
7187
+ /**
7188
+ * Proj:Shape
7189
+ *
7190
+ * [height, width] in pixels.
7191
+ */
7192
+ 'proj:shape'?: [
7193
+ number,
7194
+ number
7195
+ ] | null;
7196
+ /**
7197
+ * Raster:Bands
7198
+ */
7199
+ 'raster:bands'?: Array<OgcRasterBand> | null;
7054
7200
  };
7055
7201
  /**
7056
7202
  * OGCRecordResponse
@@ -7324,9 +7470,13 @@ export type ProbeRequest = {
7324
7470
  /**
7325
7471
  * Token
7326
7472
  *
7327
- * Optional auth token for protected services (passed as query parameter or bearer token depending on service type).
7473
+ * Optional auth token for protected services (passed as query parameter or bearer token depending on service type). Deprecated: use the auth object with method bearer.
7328
7474
  */
7329
7475
  token?: string | null;
7476
+ /**
7477
+ * Structured credential for a protected service. Mutually exclusive with the token field.
7478
+ */
7479
+ auth?: ServiceAuthRequest | null;
7330
7480
  };
7331
7481
  /**
7332
7482
  * ProbeResponse
@@ -7924,14 +8074,26 @@ export type ReuploadCommitRequest = {
7924
8074
  * Srid Override
7925
8075
  */
7926
8076
  srid_override?: number | null;
8077
+ /**
8078
+ * Expected Origin Kind
8079
+ *
8080
+ * The dataset origin the client saw when it staged this replacement. When set, the commit is refused with 409 `origin_changed` if the dataset's origin no longer matches, so a service, STAC or registered-table binding established after the upload is not silently rebound to an upload. Optional: a client that omits it keeps the pre-#1768 behaviour.
8081
+ */
8082
+ expected_origin_kind?: 'upload' | 'postgis' | 'service' | 'stac' | 'created' | null;
7927
8083
  /**
7928
8084
  * Token
8085
+ *
8086
+ * Deprecated: use the auth object with method bearer.
7929
8087
  */
7930
8088
  token?: string | null;
7931
8089
  /**
7932
8090
  * Layer Name
7933
8091
  */
7934
8092
  layer_name?: string | null;
8093
+ /**
8094
+ * Structured credential for a protected service. Mutually exclusive with the token field.
8095
+ */
8096
+ auth?: ServiceAuthRequest | null;
7935
8097
  };
7936
8098
  /**
7937
8099
  * ReuploadCommitResponse
@@ -8052,12 +8214,18 @@ export type ReuploadServicePreviewRequest = {
8052
8214
  layer_id?: number | string | null;
8053
8215
  /**
8054
8216
  * Token
8217
+ *
8218
+ * Deprecated: use the auth object with method bearer.
8055
8219
  */
8056
8220
  token?: string | null;
8057
8221
  /**
8058
8222
  * Object Id Field
8059
8223
  */
8060
8224
  object_id_field?: string | null;
8225
+ /**
8226
+ * Structured credential for a protected service. Mutually exclusive with the token field.
8227
+ */
8228
+ auth?: ServiceAuthRequest | null;
8061
8229
  };
8062
8230
  /**
8063
8231
  * SSEActionsEvent
@@ -8338,9 +8506,52 @@ export type SchemaDiff = {
8338
8506
  /**
8339
8507
  * Row Count Delta
8340
8508
  *
8341
- * row_count_new minus row_count_old
8509
+ * row_count_new minus row_count_old, or null when either side is unknown
8510
+ */
8511
+ row_count_delta: number | null;
8512
+ };
8513
+ /**
8514
+ * ServiceAuthRequest
8515
+ *
8516
+ * How one request authenticates to the remote service it names.
8517
+ */
8518
+ export type ServiceAuthRequest = {
8519
+ /**
8520
+ * Method
8521
+ *
8522
+ * How the credential is presented to the remote service. Omit the whole auth object for a public service.
8523
+ */
8524
+ method: 'bearer' | 'basic' | 'header';
8525
+ /**
8526
+ * Token
8527
+ *
8528
+ * Bearer token or API key, for method bearer.
8529
+ */
8530
+ token?: string | null;
8531
+ /**
8532
+ * Username
8533
+ *
8534
+ * Username, for method basic.
8535
+ */
8536
+ username?: string | null;
8537
+ /**
8538
+ * Password
8539
+ *
8540
+ * Password, for method basic.
8342
8541
  */
8343
- row_count_delta: number;
8542
+ password?: string | null;
8543
+ /**
8544
+ * Header Name
8545
+ *
8546
+ * Name of the header the key is sent under, for method header.
8547
+ */
8548
+ header_name?: string | null;
8549
+ /**
8550
+ * Header Value
8551
+ *
8552
+ * Value of the header the key is sent under, for method header.
8553
+ */
8554
+ header_value?: string | null;
8344
8555
  };
8345
8556
  /**
8346
8557
  * ServiceHealth
@@ -8396,7 +8607,7 @@ export type ServicePreviewRequest = {
8396
8607
  /**
8397
8608
  * Token
8398
8609
  *
8399
- * Optional auth token for protected services.
8610
+ * Optional auth token for protected services. Deprecated: use the auth object with method bearer.
8400
8611
  */
8401
8612
  token?: string | null;
8402
8613
  /**
@@ -8405,6 +8616,10 @@ export type ServicePreviewRequest = {
8405
8616
  * ArcGIS OID field name used for orderByFields during preview pagination.
8406
8617
  */
8407
8618
  object_id_field?: string | null;
8619
+ /**
8620
+ * Structured credential for a protected service. Mutually exclusive with the token field.
8621
+ */
8622
+ auth?: ServiceAuthRequest | null;
8408
8623
  };
8409
8624
  /**
8410
8625
  * ServicePreviewResponse
@@ -8822,7 +9037,7 @@ export type SourceHealthResponse = {
8822
9037
  /**
8823
9038
  * Source Health Detail
8824
9039
  *
8825
- * Why the origin is not healthy, as one of a fixed set of GeoLens codes: blocked_by_policy, item_withdrawn, network_error, not_found, server_error, timeout, unauthorized, unexpected_status. Null when healthy or never probed. Never provider text, a URL, or a response body — nothing the origin sent is stored here.
9040
+ * Why the origin is not healthy, as one of a fixed set of GeoLens codes: auth_required, blocked_by_policy, item_withdrawn, network_error, not_found, server_error, timeout, unauthorized, unexpected_status. Null when healthy or never probed. Never provider text, a URL, or a response body — nothing the origin sent is stored here.
8826
9041
  */
8827
9042
  source_health_detail?: string | null;
8828
9043
  /**
@@ -10196,7 +10411,7 @@ export type UserCreate = {
10196
10411
  /**
10197
10412
  * Password
10198
10413
  *
10199
- * Plaintext password (policy: min 12 chars, 3+ character classes)
10414
+ * Plaintext password (policy: min 12 chars, 3+ character classes, at most 72 bytes UTF-8)
10200
10415
  */
10201
10416
  password: string;
10202
10417
  /**
@@ -10910,6 +11125,10 @@ export type CreateApiKeyAdminApiKeysPostErrors = {
10910
11125
  * Not found
10911
11126
  */
10912
11127
  404: ProblemDetail;
11128
+ /**
11129
+ * Conflict — resource state prevents the operation
11130
+ */
11131
+ 409: ProblemDetail;
10913
11132
  /**
10914
11133
  * Validation error
10915
11134
  */
@@ -12256,6 +12475,59 @@ export type RejectUserAdminUsersUserIdRejectPostResponses = {
12256
12475
  204: void;
12257
12476
  };
12258
12477
  export type RejectUserAdminUsersUserIdRejectPostResponse = RejectUserAdminUsersUserIdRejectPostResponses[keyof RejectUserAdminUsersUserIdRejectPostResponses];
12478
+ export type ResetUserPasswordAdminUsersUserIdResetPasswordPostData = {
12479
+ body: AdminPasswordReset;
12480
+ path: {
12481
+ /**
12482
+ * User Id
12483
+ */
12484
+ user_id: string;
12485
+ };
12486
+ query?: never;
12487
+ url: '/admin/users/{user_id}/reset-password/';
12488
+ };
12489
+ export type ResetUserPasswordAdminUsersUserIdResetPasswordPostErrors = {
12490
+ /**
12491
+ * Bad request — invalid query parameters or payload
12492
+ */
12493
+ 400: ProblemDetail;
12494
+ /**
12495
+ * Unauthorized — missing or invalid credentials
12496
+ */
12497
+ 401: ProblemDetail;
12498
+ /**
12499
+ * Forbidden — caller lacks access to this resource
12500
+ */
12501
+ 403: ProblemDetail;
12502
+ /**
12503
+ * Not found
12504
+ */
12505
+ 404: ProblemDetail;
12506
+ /**
12507
+ * Validation error
12508
+ */
12509
+ 422: ProblemDetail;
12510
+ /**
12511
+ * Too many requests — retry after the advertised interval
12512
+ */
12513
+ 429: ProblemDetail;
12514
+ /**
12515
+ * Internal server error
12516
+ */
12517
+ 500: ProblemDetail;
12518
+ /**
12519
+ * Service unavailable — the database could not serve the request
12520
+ */
12521
+ 503: ProblemDetail;
12522
+ };
12523
+ export type ResetUserPasswordAdminUsersUserIdResetPasswordPostError = ResetUserPasswordAdminUsersUserIdResetPasswordPostErrors[keyof ResetUserPasswordAdminUsersUserIdResetPasswordPostErrors];
12524
+ export type ResetUserPasswordAdminUsersUserIdResetPasswordPostResponses = {
12525
+ /**
12526
+ * Successful Response
12527
+ */
12528
+ 200: UserResponse;
12529
+ };
12530
+ export type ResetUserPasswordAdminUsersUserIdResetPasswordPostResponse = ResetUserPasswordAdminUsersUserIdResetPasswordPostResponses[keyof ResetUserPasswordAdminUsersUserIdResetPasswordPostResponses];
12259
12531
  export type AiAvailabilityEndpointAiAvailabilityGetData = {
12260
12532
  body?: never;
12261
12533
  path?: never;
@@ -16653,6 +16925,10 @@ export type DownloadCogDatasetsDatasetIdDownloadCogGetErrors = {
16653
16925
  * Not found
16654
16926
  */
16655
16927
  404: ProblemDetail;
16928
+ /**
16929
+ * Precondition failed — the caller's If-Match no longer matches the current representation
16930
+ */
16931
+ 412: ProblemDetail;
16656
16932
  /**
16657
16933
  * Validation error
16658
16934
  */
@@ -16728,6 +17004,10 @@ export type ExportDatasetEndpointDatasetsDatasetIdExportGetErrors = {
16728
17004
  * Not found
16729
17005
  */
16730
17006
  404: ProblemDetail;
17007
+ /**
17008
+ * Precondition failed — the caller's If-Match no longer matches the current representation
17009
+ */
17010
+ 412: ProblemDetail;
16731
17011
  /**
16732
17012
  * Payload too large
16733
17013
  */
@@ -23879,6 +24159,66 @@ export type GetSavedSearchEndpointSearchSavedSearchIdGetResponses = {
23879
24159
  200: SavedSearchResponse;
23880
24160
  };
23881
24161
  export type GetSavedSearchEndpointSearchSavedSearchIdGetResponse = GetSavedSearchEndpointSearchSavedSearchIdGetResponses[keyof GetSavedSearchEndpointSearchSavedSearchIdGetResponses];
24162
+ export type ArcgisSigninServicesArcgisSigninPostData = {
24163
+ body: ArcGisSignInRequest;
24164
+ path?: never;
24165
+ query?: never;
24166
+ url: '/services/arcgis/signin/';
24167
+ };
24168
+ export type ArcgisSigninServicesArcgisSigninPostErrors = {
24169
+ /**
24170
+ * Bad request — invalid payload
24171
+ */
24172
+ 400: ProblemDetail;
24173
+ /**
24174
+ * Unauthorized — missing or invalid credentials
24175
+ */
24176
+ 401: ProblemDetail;
24177
+ /**
24178
+ * Forbidden — caller lacks write access
24179
+ */
24180
+ 403: ProblemDetail;
24181
+ /**
24182
+ * Not found
24183
+ */
24184
+ 404: ProblemDetail;
24185
+ /**
24186
+ * Conflict — resource state prevents the operation
24187
+ */
24188
+ 409: ProblemDetail;
24189
+ /**
24190
+ * Validation error
24191
+ */
24192
+ 422: ProblemDetail;
24193
+ /**
24194
+ * Too many requests — retry after the advertised interval
24195
+ */
24196
+ 429: ProblemDetail;
24197
+ /**
24198
+ * Internal server error
24199
+ */
24200
+ 500: ProblemDetail;
24201
+ /**
24202
+ * Bad gateway — the ArcGIS portal could not be reached or did not answer with a sign-in response
24203
+ */
24204
+ 502: ProblemDetail;
24205
+ /**
24206
+ * Service unavailable — the database could not serve the request
24207
+ */
24208
+ 503: ProblemDetail;
24209
+ /**
24210
+ * Gateway timeout — the ArcGIS portal did not respond in time
24211
+ */
24212
+ 504: ProblemDetail;
24213
+ };
24214
+ export type ArcgisSigninServicesArcgisSigninPostError = ArcgisSigninServicesArcgisSigninPostErrors[keyof ArcgisSigninServicesArcgisSigninPostErrors];
24215
+ export type ArcgisSigninServicesArcgisSigninPostResponses = {
24216
+ /**
24217
+ * Successful Response
24218
+ */
24219
+ 200: ArcGisSignInResponse;
24220
+ };
24221
+ export type ArcgisSigninServicesArcgisSigninPostResponse = ArcgisSigninServicesArcgisSigninPostResponses[keyof ArcgisSigninServicesArcgisSigninPostResponses];
23882
24222
  export type ListConnectorsEndpointServicesConnectorsGetData = {
23883
24223
  body?: never;
23884
24224
  path?: never;
@@ -25770,19 +26110,19 @@ export type RasterTileProxyTilesRasterProxyDatasetIdZxyFmtGetData = {
25770
26110
  /**
25771
26111
  * Pmin
25772
26112
  *
25773
- * Lower percentile clip for stretch=percentile (0–100, default 2). Absent = current p2 behavior. Must be less than pmax.
26113
+ * Lower percentile clip for stretch=percentile (0–100, default 2). Absent = current p2 behavior. Must be less than pmax. Ignored, and not validated, when stretch is not percentile.
25774
26114
  */
25775
26115
  pmin?: number | null;
25776
26116
  /**
25777
26117
  * Pmax
25778
26118
  *
25779
- * Upper percentile clip for stretch=percentile (0–100, default 98). Absent = current p98 behavior. Must be greater than pmin.
26119
+ * Upper percentile clip for stretch=percentile (0–100, default 98). Absent = current p98 behavior. Must be greater than pmin. Ignored, and not validated, when stretch is not percentile.
25780
26120
  */
25781
26121
  pmax?: number | null;
25782
26122
  /**
25783
26123
  * Sigma
25784
26124
  *
25785
- * Standard-deviation multiplier for stretch=stddev (default 2.0). Absent = current 2.0σ behavior. Must be > 0.
26125
+ * Standard-deviation multiplier for stretch=stddev (default 2.0). Absent = current 2.0σ behavior. Must be > 0. Ignored, and not validated, when stretch is not stddev.
25786
26126
  */
25787
26127
  sigma?: number | null;
25788
26128
  };