@chaosity/location-client 0.9.0 → 0.11.0

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.
Files changed (50) hide show
  1. package/README.md +307 -37
  2. package/dist/adapters/GeoPlaces.d.ts +30 -3
  3. package/dist/adapters/GeoPlaces.js +5 -1
  4. package/dist/cjs/adapters/GeoPlaces.d.ts +30 -3
  5. package/dist/cjs/adapters/GeoPlaces.js +5 -4
  6. package/dist/cjs/client/GeoPlacesClient.d.ts +16 -4
  7. package/dist/cjs/client/GeoPlacesClient.js +18 -4
  8. package/dist/cjs/client/commands.d.ts +159 -0
  9. package/dist/cjs/client/commands.js +108 -0
  10. package/dist/cjs/errors/LocationServiceException.d.ts +28 -1
  11. package/dist/cjs/errors/LocationServiceException.js +31 -2
  12. package/dist/cjs/index.d.ts +5 -3
  13. package/dist/cjs/index.js +17 -1
  14. package/dist/cjs/maps/mapEnums.d.ts +82 -4
  15. package/dist/cjs/maps/mapEnums.js +98 -5
  16. package/dist/cjs/maps/mapStyle.d.ts +87 -10
  17. package/dist/cjs/maps/mapStyle.js +28 -5
  18. package/dist/cjs/maps/staticMap.d.ts +40 -0
  19. package/dist/cjs/maps/staticMap.js +4 -0
  20. package/dist/cjs/server/LocationServiceConnector.d.ts +23 -5
  21. package/dist/cjs/server/LocationServiceConnector.js +25 -5
  22. package/dist/cjs/transport/endpoints.js +3 -0
  23. package/dist/cjs/transport/http.d.ts +2 -2
  24. package/dist/cjs/transport/http.js +2 -2
  25. package/dist/cjs/types/index.d.ts +6 -5
  26. package/dist/cjs/utils/tokenClaims.d.ts +29 -3
  27. package/dist/cjs/utils/tokenClaims.js +28 -3
  28. package/dist/client/GeoPlacesClient.d.ts +16 -4
  29. package/dist/client/GeoPlacesClient.js +18 -4
  30. package/dist/client/commands.d.ts +159 -0
  31. package/dist/client/commands.js +97 -0
  32. package/dist/errors/LocationServiceException.d.ts +28 -1
  33. package/dist/errors/LocationServiceException.js +30 -1
  34. package/dist/index.d.ts +5 -3
  35. package/dist/index.js +7 -2
  36. package/dist/maps/mapEnums.d.ts +82 -4
  37. package/dist/maps/mapEnums.js +97 -4
  38. package/dist/maps/mapStyle.d.ts +87 -10
  39. package/dist/maps/mapStyle.js +28 -5
  40. package/dist/maps/staticMap.d.ts +40 -0
  41. package/dist/maps/staticMap.js +4 -0
  42. package/dist/server/LocationServiceConnector.d.ts +23 -5
  43. package/dist/server/LocationServiceConnector.js +25 -5
  44. package/dist/transport/endpoints.js +3 -0
  45. package/dist/transport/http.d.ts +2 -2
  46. package/dist/transport/http.js +2 -2
  47. package/dist/types/index.d.ts +6 -5
  48. package/dist/utils/tokenClaims.d.ts +29 -3
  49. package/dist/utils/tokenClaims.js +28 -3
  50. package/package.json +3 -3
@@ -2,9 +2,11 @@
2
2
  /**
3
3
  * Read advisory application config out of the access token (api#65).
4
4
  *
5
- * The API puts an application's own settings — today just `countries` — into
6
- * the JWT alongside `allowedDomain` and `allowedResources`, so this library can
7
- * stop hard-coding values it has no other way of knowing.
5
+ * The API puts an application's own settings into the JWT — `countries`,
6
+ * `allowedResources` and `allowedDomain` — so this library can stop
7
+ * hard-coding values it has no other way of knowing. The last two were in the
8
+ * token all along and were not surfaced until #40, so an application could
9
+ * only learn it lacked a route from the 403.
8
10
  *
9
11
  * `biasDecimals` used to be here too. It sized the grid this library rounded
10
12
  * `BiasPosition` onto, so that nearby callers shared a server cache entry; the
@@ -24,6 +26,21 @@
24
26
  */
25
27
  Object.defineProperty(exports, "__esModule", { value: true });
26
28
  exports.readAppConfigClaims = readAppConfigClaims;
29
+ /** A list of strings, whether the claim carries it as a list or JSON-encoded. */
30
+ function readStringList(value) {
31
+ let list = value;
32
+ if (typeof list === 'string') {
33
+ try {
34
+ list = JSON.parse(list);
35
+ }
36
+ catch {
37
+ return undefined;
38
+ }
39
+ }
40
+ if (!Array.isArray(list))
41
+ return undefined;
42
+ return list.filter((v) => typeof v === 'string');
43
+ }
27
44
  /**
28
45
  * Decode a JWT payload without verifying it.
29
46
  *
@@ -50,6 +67,14 @@ function readAppConfigClaims(token) {
50
67
  if (list.length)
51
68
  claims.countries = list;
52
69
  }
70
+ // Kept when empty, unlike countries: no countries means "search the
71
+ // world", but no resources means an application entitled to nothing.
72
+ const resources = readStringList(payload.allowedResources);
73
+ if (resources)
74
+ claims.allowedResources = resources;
75
+ if (typeof payload.allowedDomain === 'string' && payload.allowedDomain) {
76
+ claims.allowedDomain = payload.allowedDomain;
77
+ }
53
78
  return claims;
54
79
  }
55
80
  catch {
@@ -1,6 +1,7 @@
1
1
  import type { RequestOptions } from '../transport/http.js';
2
2
  import type { ClientConfig } from '../types/index.js';
3
3
  import type { AppConfigClaims } from '../utils/tokenClaims.js';
4
+ import type { VerifyAddressResponse } from './commands.js';
4
5
  export type SendOptions = RequestOptions;
5
6
  /**
6
7
  * GeoPlacesClient — AWS Location Service compatible client with custom auth.
@@ -18,17 +19,19 @@ export declare class GeoPlacesClient {
18
19
  constructor(config: ClientConfig);
19
20
  /**
20
21
  * This application's own configuration, as carried on the access token
21
- * (api#65) — today, the countries it is scoped to.
22
+ * (api#65): the routes it may call, the domain its requests must come from,
23
+ * and the countries it is scoped to (#40).
22
24
  *
23
25
  * Provided so an application can SHOW its own settings: populate a country
24
26
  * selector with the markets it actually serves, label a settings screen,
25
27
  * and so on. Being a few minutes stale is cosmetic for that.
26
28
  *
27
29
  * It is not an entitlement check. See AppConfigClaims for why acting on
28
- * `countries` client-side makes requests fail that would otherwise succeed.
30
+ * any of it client-side makes requests fail that would otherwise succeed.
29
31
  *
30
- * Returns `{}` when the token carries no application config, which is the
31
- * case until one is configured in the portal.
32
+ * Every token the API issues carries `allowedResources` and `allowedDomain`;
33
+ * `countries` only once a scope is configured in the portal. Returns `{}`
34
+ * for a token carrying none of them.
32
35
  */
33
36
  getAppConfig(): AppConfigClaims;
34
37
  /** Prefer the getToken callback (live ref) over a static token string. */
@@ -46,5 +49,14 @@ export declare class GeoPlacesClient {
46
49
  * retry loop. Every failure throws LocationServiceException.
47
50
  */
48
51
  send<TInput, TOutput>(command: TInput, options?: SendOptions): Promise<TOutput>;
52
+ /**
53
+ * Verify a PlaceId: `send(new VerifyAddressCommand({ PlaceId }))`, typed
54
+ * (#54). Resolves the full place record plus `verified`, and resolves a
55
+ * `verified: false` too — see VerifyAddressResponse for what may be stored.
56
+ *
57
+ * Billed per call, whether or not the address verifies: call it once per
58
+ * chosen PlaceId, at submit, never per keystroke.
59
+ */
60
+ verifyAddress(placeId: string, options?: SendOptions): Promise<VerifyAddressResponse>;
49
61
  private dispatch;
50
62
  }
@@ -3,6 +3,7 @@ import { resolveEndpoint } from '../transport/endpoints.js';
3
3
  import { isTokenRejected, noTokenAvailable } from '../transport/errors.js';
4
4
  import { requestJson } from '../transport/http.js';
5
5
  import { readAppConfigClaims } from '../utils/tokenClaims.js';
6
+ import { VerifyAddressCommand } from './commands.js';
6
7
  const log = debug('location-client:api');
7
8
  /**
8
9
  * GeoPlacesClient — AWS Location Service compatible client with custom auth.
@@ -19,17 +20,19 @@ export class GeoPlacesClient {
19
20
  }
20
21
  /**
21
22
  * This application's own configuration, as carried on the access token
22
- * (api#65) — today, the countries it is scoped to.
23
+ * (api#65): the routes it may call, the domain its requests must come from,
24
+ * and the countries it is scoped to (#40).
23
25
  *
24
26
  * Provided so an application can SHOW its own settings: populate a country
25
27
  * selector with the markets it actually serves, label a settings screen,
26
28
  * and so on. Being a few minutes stale is cosmetic for that.
27
29
  *
28
30
  * It is not an entitlement check. See AppConfigClaims for why acting on
29
- * `countries` client-side makes requests fail that would otherwise succeed.
31
+ * any of it client-side makes requests fail that would otherwise succeed.
30
32
  *
31
- * Returns `{}` when the token carries no application config, which is the
32
- * case until one is configured in the portal.
33
+ * Every token the API issues carries `allowedResources` and `allowedDomain`;
34
+ * `countries` only once a scope is configured in the portal. Returns `{}`
35
+ * for a token carrying none of them.
33
36
  */
34
37
  getAppConfig() {
35
38
  return readAppConfigClaims(this.currentToken());
@@ -92,6 +95,17 @@ export class GeoPlacesClient {
92
95
  return await this.dispatch(url, fresh, cmd, options);
93
96
  }
94
97
  }
98
+ /**
99
+ * Verify a PlaceId: `send(new VerifyAddressCommand({ PlaceId }))`, typed
100
+ * (#54). Resolves the full place record plus `verified`, and resolves a
101
+ * `verified: false` too — see VerifyAddressResponse for what may be stored.
102
+ *
103
+ * Billed per call, whether or not the address verifies: call it once per
104
+ * chosen PlaceId, at submit, never per keystroke.
105
+ */
106
+ verifyAddress(placeId, options) {
107
+ return this.send(new VerifyAddressCommand({ PlaceId: placeId }), options);
108
+ }
95
109
  dispatch(url, token, cmd, options) {
96
110
  // The caller's input goes out as the caller wrote it. `BiasPosition` used
97
111
  // to be rounded here to a grid sized by a token claim, so nearby callers
@@ -0,0 +1,159 @@
1
+ import type { GetPlaceResponse, AutocompleteCommandInput as SdkAutocompleteCommandInput, AutocompleteRequest as SdkAutocompleteRequest, GeocodeCommandInput as SdkGeocodeCommandInput, GeocodeRequest as SdkGeocodeRequest, GetPlaceCommandInput as SdkGetPlaceCommandInput, GetPlaceRequest as SdkGetPlaceRequest, ReverseGeocodeCommandInput as SdkReverseGeocodeCommandInput, ReverseGeocodeRequest as SdkReverseGeocodeRequest, SearchNearbyCommandInput as SdkSearchNearbyCommandInput, SearchNearbyRequest as SdkSearchNearbyRequest, SearchTextCommandInput as SdkSearchTextCommandInput, SearchTextRequest as SdkSearchTextRequest, SuggestCommandInput as SdkSuggestCommandInput, SuggestRequest as SdkSuggestRequest } from '@aws-sdk/client-geo-places';
2
+ import { AutocompleteCommand as SdkAutocompleteCommand, GeocodeCommand as SdkGeocodeCommand, GetPlaceCommand as SdkGetPlaceCommand, ReverseGeocodeCommand as SdkReverseGeocodeCommand, SearchNearbyCommand as SdkSearchNearbyCommand, SearchTextCommand as SdkSearchTextCommand, SuggestCommand as SdkSuggestCommand } from '@aws-sdk/client-geo-places';
3
+ /**
4
+ * Request fields the Location Service removes from every request (#40).
5
+ *
6
+ * `IntendedUse` chooses the price bucket the service pays, and `Key` is an
7
+ * Amazon Location API key that would bill someone else's account, so neither
8
+ * ever reaches Amazon. The SDK's inputs declare both, and this package used to
9
+ * re-export those commands as they were: `IntendedUse: 'Storage'` compiled,
10
+ * was sent, was stripped, and came back as a result with no storage rights.
11
+ *
12
+ * So the root exports every Places command as a subclass whose constructor
13
+ * takes the input WITHOUT these fields. Narrowing only the input types would
14
+ * not have been enough — the SDK's constructor references the SDK's own type,
15
+ * so `new SearchTextCommand({ IntendedUse })` would still have compiled.
16
+ *
17
+ * Types only. Nothing is removed at runtime: a request body is the caller's
18
+ * input, unchanged, and the service does the stripping. A caller who casts
19
+ * past the type still sends the field and still has it ignored.
20
+ *
21
+ * `test/places-commands.test.ts` reads the command list from the SDK itself,
22
+ * so a command the SDK adds fails there until it is narrowed here.
23
+ */
24
+ export type NeverForwarded = 'IntendedUse' | 'Key';
25
+ export type AutocompleteRequest = Omit<SdkAutocompleteRequest, NeverForwarded>;
26
+ export type AutocompleteCommandInput = Omit<SdkAutocompleteCommandInput, NeverForwarded>;
27
+ export declare class AutocompleteCommand extends SdkAutocompleteCommand {
28
+ constructor(input: AutocompleteCommandInput);
29
+ }
30
+ export type GeocodeRequest = Omit<SdkGeocodeRequest, NeverForwarded>;
31
+ export type GeocodeCommandInput = Omit<SdkGeocodeCommandInput, NeverForwarded>;
32
+ /**
33
+ * Accepts rich place data, a plan feature: on a plan without it these
34
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
35
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
36
+ *
37
+ * @planFeature rich place data — Access, TimeZone
38
+ */
39
+ export declare class GeocodeCommand extends SdkGeocodeCommand {
40
+ constructor(input: GeocodeCommandInput);
41
+ }
42
+ export type GetPlaceRequest = Omit<SdkGetPlaceRequest, NeverForwarded>;
43
+ export type GetPlaceCommandInput = Omit<SdkGetPlaceCommandInput, NeverForwarded>;
44
+ /**
45
+ * Accepts rich place data, a plan feature: on a plan without it these
46
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
47
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
48
+ *
49
+ * @planFeature rich place data — Access, Contact, Phonemes, TimeZone
50
+ */
51
+ export declare class GetPlaceCommand extends SdkGetPlaceCommand {
52
+ constructor(input: GetPlaceCommandInput);
53
+ }
54
+ export type ReverseGeocodeRequest = Omit<SdkReverseGeocodeRequest, NeverForwarded>;
55
+ export type ReverseGeocodeCommandInput = Omit<SdkReverseGeocodeCommandInput, NeverForwarded>;
56
+ /**
57
+ * Accepts rich place data, a plan feature: on a plan without it these
58
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
59
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
60
+ *
61
+ * @planFeature rich place data — Access, TimeZone
62
+ */
63
+ export declare class ReverseGeocodeCommand extends SdkReverseGeocodeCommand {
64
+ constructor(input: ReverseGeocodeCommandInput);
65
+ }
66
+ export type SearchNearbyRequest = Omit<SdkSearchNearbyRequest, NeverForwarded>;
67
+ export type SearchNearbyCommandInput = Omit<SdkSearchNearbyCommandInput, NeverForwarded>;
68
+ /**
69
+ * Accepts rich place data, a plan feature: on a plan without it these
70
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
71
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
72
+ *
73
+ * @planFeature rich place data — Access, Contact, Phonemes, TimeZone
74
+ */
75
+ export declare class SearchNearbyCommand extends SdkSearchNearbyCommand {
76
+ constructor(input: SearchNearbyCommandInput);
77
+ }
78
+ export type SearchTextRequest = Omit<SdkSearchTextRequest, NeverForwarded>;
79
+ export type SearchTextCommandInput = Omit<SdkSearchTextCommandInput, NeverForwarded>;
80
+ /**
81
+ * Accepts rich place data, a plan feature: on a plan without it these
82
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
83
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
84
+ *
85
+ * @planFeature rich place data — Access, Contact, Phonemes, TimeZone
86
+ */
87
+ export declare class SearchTextCommand extends SdkSearchTextCommand {
88
+ constructor(input: SearchTextCommandInput);
89
+ }
90
+ export type SuggestRequest = Omit<SdkSuggestRequest, NeverForwarded>;
91
+ export type SuggestCommandInput = Omit<SdkSuggestCommandInput, NeverForwarded>;
92
+ /**
93
+ * Accepts rich place data, a plan feature: on a plan without it these
94
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
95
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
96
+ *
97
+ * @planFeature rich place data — Access, Phonemes, TimeZone
98
+ */
99
+ export declare class SuggestCommand extends SdkSuggestCommand {
100
+ constructor(input: SuggestCommandInput);
101
+ }
102
+ /**
103
+ * A PlaceId, and nothing else: the service forwards `PlaceId` alone to this
104
+ * route, so `Language`, `PoliticalView` and `AdditionalFeatures` would be
105
+ * dropped rather than honoured. The type refuses them instead (#54).
106
+ */
107
+ export interface VerifyAddressCommandInput {
108
+ /**
109
+ * From an autocomplete, suggestion, geocode or place result — including a
110
+ * unit's, from a place's `SecondaryAddresses`.
111
+ */
112
+ PlaceId: string;
113
+ }
114
+ /**
115
+ * The answer to a verify: the record `GetPlaceCommand` returns — the
116
+ * building's units in `SecondaryAddresses` included, `$metadata` not — plus
117
+ * `verified`.
118
+ *
119
+ * `verified` is true for a `PointAddress`, or a `SecondaryAddress` (a unit),
120
+ * and false for anything else: an interpolated address, a street, a locality,
121
+ * a point of interest. A `false` is still a 200 and still billed, so it
122
+ * resolves; it never throws.
123
+ *
124
+ * This is the one Places result an integrator may store, except a place in
125
+ * Japan, which may not be stored at all. Every other Places result is for
126
+ * display.
127
+ *
128
+ * Keep the PlaceId you sent beside it. The answer's own `PlaceId` can differ,
129
+ * and for a unit it does: the service fails that one on every Places route,
130
+ * while the one you sent verifies again.
131
+ */
132
+ export type VerifyAddressResponse = Omit<GetPlaceResponse, 'PricingBucket'> & {
133
+ /**
134
+ * The bucket the stored record belongs to (`Stored`), not what this call
135
+ * was billed at. Every verify is billed on its own meter, whether the
136
+ * service answered it from its store or not.
137
+ */
138
+ PricingBucket: string | undefined;
139
+ /** `PointAddress` or `SecondaryAddress`: the address is verified. */
140
+ verified: boolean;
141
+ };
142
+ /**
143
+ * `POST /address/verify` (#54): resolve one PlaceId to the full place record
144
+ * plus `verified`. `GeoPlacesClient.verifyAddress` and
145
+ * `LocationServiceConnector.verifyAddress` send this.
146
+ *
147
+ * Billed per call, whether or not the address verifies. Send it once per
148
+ * chosen PlaceId — at submit — never per keystroke. A repeat verify of the
149
+ * same PlaceId may be answered from the service's own store, and is billed
150
+ * all the same.
151
+ *
152
+ * Not an SDK command: the route has none. It extends nothing on purpose —
153
+ * `ENDPOINTS` matches by `instanceof`, so a subclass of `GetPlaceCommand`
154
+ * would match that entry and go to `/address/place`.
155
+ */
156
+ export declare class VerifyAddressCommand {
157
+ readonly input: VerifyAddressCommandInput;
158
+ constructor(input: VerifyAddressCommandInput);
159
+ }
@@ -0,0 +1,97 @@
1
+ import { AutocompleteCommand as SdkAutocompleteCommand, GeocodeCommand as SdkGeocodeCommand, GetPlaceCommand as SdkGetPlaceCommand, ReverseGeocodeCommand as SdkReverseGeocodeCommand, SearchNearbyCommand as SdkSearchNearbyCommand, SearchTextCommand as SdkSearchTextCommand, SuggestCommand as SdkSuggestCommand, } from '@aws-sdk/client-geo-places';
2
+ export class AutocompleteCommand extends SdkAutocompleteCommand {
3
+ constructor(input) {
4
+ super(input);
5
+ }
6
+ }
7
+ /**
8
+ * Accepts rich place data, a plan feature: on a plan without it these
9
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
10
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
11
+ *
12
+ * @planFeature rich place data — Access, TimeZone
13
+ */
14
+ export class GeocodeCommand extends SdkGeocodeCommand {
15
+ constructor(input) {
16
+ super(input);
17
+ }
18
+ }
19
+ /**
20
+ * Accepts rich place data, a plan feature: on a plan without it these
21
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
22
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
23
+ *
24
+ * @planFeature rich place data — Access, Contact, Phonemes, TimeZone
25
+ */
26
+ export class GetPlaceCommand extends SdkGetPlaceCommand {
27
+ constructor(input) {
28
+ super(input);
29
+ }
30
+ }
31
+ /**
32
+ * Accepts rich place data, a plan feature: on a plan without it these
33
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
34
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
35
+ *
36
+ * @planFeature rich place data — Access, TimeZone
37
+ */
38
+ export class ReverseGeocodeCommand extends SdkReverseGeocodeCommand {
39
+ constructor(input) {
40
+ super(input);
41
+ }
42
+ }
43
+ /**
44
+ * Accepts rich place data, a plan feature: on a plan without it these
45
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
46
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
47
+ *
48
+ * @planFeature rich place data — Access, Contact, Phonemes, TimeZone
49
+ */
50
+ export class SearchNearbyCommand extends SdkSearchNearbyCommand {
51
+ constructor(input) {
52
+ super(input);
53
+ }
54
+ }
55
+ /**
56
+ * Accepts rich place data, a plan feature: on a plan without it these
57
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
58
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
59
+ *
60
+ * @planFeature rich place data — Access, Contact, Phonemes, TimeZone
61
+ */
62
+ export class SearchTextCommand extends SdkSearchTextCommand {
63
+ constructor(input) {
64
+ super(input);
65
+ }
66
+ }
67
+ /**
68
+ * Accepts rich place data, a plan feature: on a plan without it these
69
+ * `AdditionalFeatures` are refused 403 `FeatureNotEntitledException`
70
+ * (`isFeatureNotEntitled` on the error; see `FEATURE_NOT_ENTITLED`).
71
+ *
72
+ * @planFeature rich place data — Access, Phonemes, TimeZone
73
+ */
74
+ export class SuggestCommand extends SdkSuggestCommand {
75
+ constructor(input) {
76
+ super(input);
77
+ }
78
+ }
79
+ /**
80
+ * `POST /address/verify` (#54): resolve one PlaceId to the full place record
81
+ * plus `verified`. `GeoPlacesClient.verifyAddress` and
82
+ * `LocationServiceConnector.verifyAddress` send this.
83
+ *
84
+ * Billed per call, whether or not the address verifies. Send it once per
85
+ * chosen PlaceId — at submit — never per keystroke. A repeat verify of the
86
+ * same PlaceId may be answered from the service's own store, and is billed
87
+ * all the same.
88
+ *
89
+ * Not an SDK command: the route has none. It extends nothing on purpose —
90
+ * `ENDPOINTS` matches by `instanceof`, so a subclass of `GetPlaceCommand`
91
+ * would match that entry and go to `/address/place`.
92
+ */
93
+ export class VerifyAddressCommand {
94
+ constructor(input) {
95
+ this.input = input;
96
+ }
97
+ }
@@ -1,3 +1,17 @@
1
+ /**
2
+ * The code of a 403 for an option the application's plan does not include
3
+ * (#55): a map feature such as `satellite` or `terrain`, or rich place data.
4
+ * The options that can earn it are tagged `@planFeature` in their
5
+ * documentation.
6
+ *
7
+ * The service refuses before calling upstream, so the refusal is not billed,
8
+ * and its message names each refused feature and the option that asked for
9
+ * it. It never names a plan: which plan includes which feature can change
10
+ * without a release of this package — see https://chaosity.cloud/pricing.
11
+ * Nothing in the token lists the features either, so this 403 is the first a
12
+ * caller hears of it; there is no check to make beforehand.
13
+ */
14
+ export declare const FEATURE_NOT_ENTITLED = "FeatureNotEntitledException";
1
15
  export interface LocationServiceExceptionOptions {
2
16
  message: string;
3
17
  code: string;
@@ -36,8 +50,21 @@ export declare class LocationServiceException extends Error {
36
50
  get isRetryable(): boolean;
37
51
  get isThrottling(): boolean;
38
52
  get isValidation(): boolean;
39
- /** Credentials or entitlements — the caller must act, retrying will not help. */
53
+ /**
54
+ * Any 401 or 403 — the caller must act, and retrying will not help.
55
+ *
56
+ * That is several failures with different remedies: bad or expired
57
+ * credentials, an `Origin` the application does not allow, a route its plan
58
+ * does not include, an option its plan does not include. Branch on `code`,
59
+ * or on `isFeatureNotEntitled` for the last, to tell them apart.
60
+ */
40
61
  get isAuth(): boolean;
62
+ /**
63
+ * The application's plan does not include an option this request asked for
64
+ * (`FEATURE_NOT_ENTITLED`). The message names the feature; drop the option,
65
+ * or move the application to a plan that includes it.
66
+ */
67
+ get isFeatureNotEntitled(): boolean;
41
68
  get isAborted(): boolean;
42
69
  get isTimeout(): boolean;
43
70
  toString(): string;
@@ -1,3 +1,17 @@
1
+ /**
2
+ * The code of a 403 for an option the application's plan does not include
3
+ * (#55): a map feature such as `satellite` or `terrain`, or rich place data.
4
+ * The options that can earn it are tagged `@planFeature` in their
5
+ * documentation.
6
+ *
7
+ * The service refuses before calling upstream, so the refusal is not billed,
8
+ * and its message names each refused feature and the option that asked for
9
+ * it. It never names a plan: which plan includes which feature can change
10
+ * without a release of this package — see https://chaosity.cloud/pricing.
11
+ * Nothing in the token lists the features either, so this 403 is the first a
12
+ * caller hears of it; there is no check to make beforehand.
13
+ */
14
+ export const FEATURE_NOT_ENTITLED = 'FeatureNotEntitledException';
1
15
  /**
2
16
  * The single error type this package throws.
3
17
  *
@@ -37,10 +51,25 @@ export class LocationServiceException extends Error {
37
51
  get isValidation() {
38
52
  return this.code === 'ValidationException' || this.statusCode === 400;
39
53
  }
40
- /** Credentials or entitlements — the caller must act, retrying will not help. */
54
+ /**
55
+ * Any 401 or 403 — the caller must act, and retrying will not help.
56
+ *
57
+ * That is several failures with different remedies: bad or expired
58
+ * credentials, an `Origin` the application does not allow, a route its plan
59
+ * does not include, an option its plan does not include. Branch on `code`,
60
+ * or on `isFeatureNotEntitled` for the last, to tell them apart.
61
+ */
41
62
  get isAuth() {
42
63
  return this.statusCode === 401 || this.statusCode === 403;
43
64
  }
65
+ /**
66
+ * The application's plan does not include an option this request asked for
67
+ * (`FEATURE_NOT_ENTITLED`). The message names the feature; drop the option,
68
+ * or move the application to a plan that includes it.
69
+ */
70
+ get isFeatureNotEntitled() {
71
+ return this.code === FEATURE_NOT_ENTITLED;
72
+ }
44
73
  get isAborted() {
45
74
  return this.code === 'AbortedException';
46
75
  }
package/dist/index.d.ts CHANGED
@@ -3,9 +3,11 @@ export type { SendOptions } from './client/GeoPlacesClient.js';
3
3
  export { DEFAULT_MAX_ATTEMPTS, DEFAULT_OVERALL_TIMEOUT_MS, DEFAULT_TIMEOUT_MS, } from './transport/http.js';
4
4
  export type { RequestOptions } from './transport/http.js';
5
5
  export { TOKEN_REFRESH_BUFFER_SECONDS, readTokenExpiry, } from './auth/tokenRefresh.js';
6
- export { LocationServiceException } from './errors/LocationServiceException.js';
6
+ export { FEATURE_NOT_ENTITLED, LocationServiceException, } from './errors/LocationServiceException.js';
7
7
  export type { LocationServiceExceptionOptions } from './errors/LocationServiceException.js';
8
8
  export * from '@aws-sdk/client-geo-places';
9
+ export { AutocompleteCommand, GeocodeCommand, GetPlaceCommand, ReverseGeocodeCommand, SearchNearbyCommand, SearchTextCommand, SuggestCommand, VerifyAddressCommand, } from './client/commands.js';
10
+ export type { AutocompleteCommandInput, AutocompleteRequest, GeocodeCommandInput, GeocodeRequest, GetPlaceCommandInput, GetPlaceRequest, NeverForwarded, ReverseGeocodeCommandInput, ReverseGeocodeRequest, SearchNearbyCommandInput, SearchNearbyRequest, SearchTextCommandInput, SearchTextRequest, SuggestCommandInput, SuggestRequest, VerifyAddressCommandInput, VerifyAddressResponse, } from './client/commands.js';
9
11
  export * from '@aws/amazon-location-utilities-datatypes';
10
12
  export { GeoPlaces } from './adapters/GeoPlaces.js';
11
13
  export type { GeoPlacesDetailOptions, GeoPlacesOptions, } from './adapters/GeoPlaces.js';
@@ -17,8 +19,8 @@ export { buildMapStyleUrl, fetchMapStyle } from './maps/mapStyle.js';
17
19
  export type { MapStyleOptions } from './maps/mapStyle.js';
18
20
  export { buildStaticMapUrl, fetchStaticMap, staticMapAccept, } from './maps/staticMap.js';
19
21
  export type { StaticMapFileName, StaticMapOptions } from './maps/staticMap.js';
20
- export { BUILDINGS, COLOR_SCHEMES, CONTOUR_DENSITIES, LABEL_SIZES, MAP_FEATURE_MODES, MAP_STYLES, SCALE_BAR_UNITS, SPRITE_VARIANTS, STATIC_MAP_STYLES, TERRAINS, TRAFFIC_MODES, TRAVEL_MODES, } from './maps/mapEnums.js';
21
- export type { Buildings, ColorScheme, ContourDensity, LabelSize, MapFeatureMode, MapStyle, ScaleBarUnit, SpriteVariant, StaticMapStyle, Terrain, TrafficMode, TravelMode, } from './maps/mapEnums.js';
22
+ export { BUILDINGS, COLOR_SCHEMES, CONTOUR_DENSITIES, LABEL_SIZES, MAP_FEATURE_MODES, MAP_STYLES, POI_DENSITIES, SCALE_BAR_UNITS, SPRITE_VARIANTS, STATIC_MAP_STYLES, STYLE_POI_CATEGORIES, TERRAINS, TRAFFIC_MODES, TRAVEL_MODES, } from './maps/mapEnums.js';
23
+ export type { Buildings, ColorScheme, ContourDensity, LabelSize, MapFeatureMode, MapStyle, PoiDensity, ScaleBarUnit, SpriteVariant, StaticMapStyle, StylePoiCategory, Terrain, TrafficMode, TravelMode, } from './maps/mapEnums.js';
22
24
  export { transformRequest } from './maps/Utils.js';
23
25
  export type { ClientConfig, GeoPlacesCommand, MapLike } from './types/index.js';
24
26
  export type { AppConfigClaims } from './utils/tokenClaims.js';
package/dist/index.js CHANGED
@@ -5,9 +5,14 @@ export { DEFAULT_MAX_ATTEMPTS, DEFAULT_OVERALL_TIMEOUT_MS, DEFAULT_TIMEOUT_MS, }
5
5
  // Token refresh policy — shared by the server provider and the React provider
6
6
  export { TOKEN_REFRESH_BUFFER_SECONDS, readTokenExpiry, } from './auth/tokenRefresh.js';
7
7
  // Errors
8
- export { LocationServiceException } from './errors/LocationServiceException.js';
8
+ export { FEATURE_NOT_ENTITLED, LocationServiceException, } from './errors/LocationServiceException.js';
9
9
  // Re-export AWS SDK commands and types
10
10
  export * from '@aws-sdk/client-geo-places';
11
+ // …except the seven Places commands and their inputs, which take neither
12
+ // IntendedUse nor Key: the service strips both from every request (#40). A
13
+ // named export wins over the `export *` above, as GeoPlacesClient's does.
14
+ // VerifyAddressCommand is this package's own: its route has no SDK command (#54).
15
+ export { AutocompleteCommand, GeocodeCommand, GetPlaceCommand, ReverseGeocodeCommand, SearchNearbyCommand, SearchTextCommand, SuggestCommand, VerifyAddressCommand, } from './client/commands.js';
11
16
  // Re-export AWS Location Utilities (data type conversions)
12
17
  export * from '@aws/amazon-location-utilities-datatypes';
13
18
  // Adapters (Custom - for MapLibre integration)
@@ -20,6 +25,6 @@ export { buildMapStyleUrl, fetchMapStyle } from './maps/mapStyle.js';
20
25
  export { buildStaticMapUrl, fetchStaticMap, staticMapAccept, } from './maps/staticMap.js';
21
26
  // Accepted values for every map parameter, as VALUES so a picker can be built
22
27
  // from them, plus the matching types. Case sensitive — see mapEnums.ts.
23
- export { BUILDINGS, COLOR_SCHEMES, CONTOUR_DENSITIES, LABEL_SIZES, MAP_FEATURE_MODES, MAP_STYLES, SCALE_BAR_UNITS, SPRITE_VARIANTS, STATIC_MAP_STYLES, TERRAINS, TRAFFIC_MODES, TRAVEL_MODES, } from './maps/mapEnums.js';
28
+ export { BUILDINGS, COLOR_SCHEMES, CONTOUR_DENSITIES, LABEL_SIZES, MAP_FEATURE_MODES, MAP_STYLES, POI_DENSITIES, SCALE_BAR_UNITS, SPRITE_VARIANTS, STATIC_MAP_STYLES, STYLE_POI_CATEGORIES, TERRAINS, TRAFFIC_MODES, TRAVEL_MODES, } from './maps/mapEnums.js';
24
29
  export { transformRequest } from './maps/Utils.js';
25
30
  // Server-only utilities are available via '@chaosity/location-client/server'