Skip to content

chore: sync updates to google.maps #69942

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 1 commit into from
Jun 29, 2024
Merged

chore: sync updates to google.maps #69942

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion types/google.maps/google.maps-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
// No tests required for generated types
// Synced from: https://github.com/googlemaps/js-types/commit/459d2ae96ebbbe03423008158d5c2df6c50ba6f4
// Synced from: https://github.com/googlemaps/js-types/commit/b9371da31d06cfd28ffcc926bd81c1e0607432f5
google.maps.Map;
237 changes: 231 additions & 6 deletions types/google.maps/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,24 @@
// Generated by an automated process. DO NOT EDIT!

declare namespace google.maps {
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
*
* A relational description of a location. Includes a ranked set of nearby
* landmarks and the areas containing the target location.
*/
export interface AddressDescriptor {
/**
* A ranked list of containing or adjacent areas. The most useful
* (recognizable and precise) areas are ranked first.
*/
areas: google.maps.Area[];
/**
* A ranked list of nearby landmarks. The most useful (recognizable and
* nearby) landmarks are ranked first.
*/
landmarks: google.maps.Landmark[];
}
/**
* Animations that can be played on a marker. Use the {@link
* google.maps.Marker.setAnimation} method on Marker or the {@link
Expand All @@ -36,6 +54,32 @@ declare namespace google.maps {
*/
DROP = 1.0,
}
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
*
* A place that is a small region, such as a neighborhood, sublocality, or
* large complex that contains the target location.
*/
export interface Area {
/**
* Defines the spatial relationship between the target location and the
* area.
*/
containment: google.maps.Containment;
/**
* The name for the area.
*/
display_name: string;
/**
* The language of the name for the area.
*/
display_name_language_code: string;
/**
* The Place ID of the underlying area. Can be used to resolve more
* information about the area through Place Details or Place ID Lookup.
*/
place_id: string;
}
/**
* A layer showing bike lanes and paths.
*
Expand Down Expand Up @@ -267,6 +311,30 @@ declare namespace google.maps {
*/
REQUIRED_AND_HIDES_OPTIONAL = 'REQUIRED_AND_HIDES_OPTIONAL',
}
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
*
* An enum representing the spatial relationship between the area and the
* target location.
*
* Access by calling `const {Containment} = await
* google.maps.importLibrary("geocoding")`. See
* https://developers.google.com/maps/documentation/javascript/libraries.
*/
export enum Containment {
/**
* The target location is outside the area region, but close by.
*/
NEAR = 'NEAR',
/**
* The target location is within the area region, close to the edge.
*/
OUTSKIRTS = 'OUTSKIRTS',
/**
* The target location is within the area region, close to the center.
*/
WITHIN = 'WITHIN',
}
/**
* Identifiers used to specify the placement of controls on the map. Controls
* are positioned relative to other controls in the same layout position.
Expand Down Expand Up @@ -1710,6 +1778,21 @@ declare namespace google.maps {
*/
error: Error;
}
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
*
* Extra computations to perform while completing a geocoding request.
*
* Access by calling `const {ExtraGeocodeComputation} = await
* google.maps.importLibrary("geocoding")`. See
* https://developers.google.com/maps/documentation/javascript/libraries.
*/
export enum ExtraGeocodeComputation {
/**
* Generate an address descriptor.
*/
ADDRESS_DESCRIPTORS = 'ADDRESS_DESCRIPTORS',
}
/**
* An interface representing a vector map tile feature. These are inputs to
* the <code>FeatureStyleFunction</code>. Do not save a reference to a
Expand Down Expand Up @@ -2022,6 +2105,18 @@ declare namespace google.maps {
* and partial matching as other geocoding requests. Optional.
*/
componentRestrictions?: google.maps.GeocoderComponentRestrictions | null;
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
* A list of extra computations which may be used to complete the request.
* Note: These extra computations may return extra fields on the response.
*/
extraComputations?: google.maps.ExtraGeocodeComputation[];
/**
* Fulfill the promise on a ZERO_RESULT status in the response. This may be
* desired because even with zero geocoding results there may still be
* additional response level fields returned.
*/
fulfillOnZeroResults?: boolean | null;
/**
* A language identifier for the language in which results should be
* returned, when possible. See the <a
Expand Down Expand Up @@ -2064,6 +2159,18 @@ declare namespace google.maps {
* the list of {@link google.maps.GeocoderResult}s.
*/
export interface GeocoderResponse {
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
* A relational description of a location. Includes a ranked set of nearby
* landmarks and the areas containing the target location. It is only
* populated for reverse geocoding requests and only when {@link
* google.maps.ExtraGeocodeComputation.ADDRESS_DESCRIPTORS} is enabled.
*/
address_descriptor?: google.maps.AddressDescriptor;
/**
* The plus code associated with the location.
*/
plus_code?: google.maps.places.PlacePlusCode;
/**
* The list of {@link google.maps.GeocoderResult}s.
*/
Expand All @@ -2080,6 +2187,16 @@ declare namespace google.maps {
* An array of <code>GeocoderAddressComponent</code>s
*/
address_components: google.maps.GeocoderAddressComponent[];
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
* A relational description of the location associated with this geocode.
* Includes a ranked set of nearby landmarks and the areas containing the
* target location. This will only be populated for forward geocoding and
* place ID lookup requests, only when {@link
* google.maps.ExtraGeocodeComputation.ADDRESS_DESCRIPTORS} is enabled, and
* only for certain localized places.
*/
address_descriptor?: google.maps.AddressDescriptor;
/**
* A string containing the human-readable address of this location.
*/
Expand Down Expand Up @@ -2163,9 +2280,12 @@ declare namespace google.maps {
ZERO_RESULTS = 'ZERO_RESULTS',
}
export interface GeocodingLibrary {
Containment: typeof google.maps.Containment;
ExtraGeocodeComputation: typeof google.maps.ExtraGeocodeComputation;
Geocoder: typeof google.maps.Geocoder;
GeocoderLocationType: typeof google.maps.GeocoderLocationType;
GeocoderStatus: typeof google.maps.GeocoderStatus;
SpatialRelationship: typeof google.maps.SpatialRelationship;
}
export interface GeometryLibrary {
encoding: typeof google.maps.geometry.encoding;
Expand Down Expand Up @@ -2451,8 +2571,14 @@ declare namespace google.maps {
*/
focus(): void;
getContent(): string | Element | null | Text | undefined;
getHeaderContent(): string | Element | null | Text | undefined;
getHeaderDisabled(): boolean | undefined;
getPosition(): google.maps.LatLng | null | undefined;
getZIndex(): number;
/**
* Checks if the InfoWindow is open.
*/
isOpen: boolean;
/**
* Opens this InfoWindow on the given map. Optionally, an InfoWindow can be
* associated with an anchor. In the core API, the only anchor is the Marker
Expand Down Expand Up @@ -2487,6 +2613,16 @@ declare namespace google.maps {
* @param content The content to be displayed by this InfoWindow.
*/
setContent(content?: string | Element | null | Text): void;
/**
* @param headerContent The header content to be displayed by this
* InfoWindow. See {@link google.maps.InfoWindowOptions.headerContent}.
*/
setHeaderContent(headerContent?: string | Element | null | Text): void;
/**
* @param headerDisabled Specifies whether to disable the whole header row.
* See {@link google.maps.InfoWindowOptions.headerDisabled}.
*/
setHeaderDisabled(headerDisabled?: boolean | null): void;
setOptions(options?: google.maps.InfoWindowOptions | null): void;
/**
* @param position The LatLng position at which to display this InfoWindow.
Expand Down Expand Up @@ -2552,15 +2688,13 @@ declare namespace google.maps {
*/
disableAutoPan?: boolean | null;
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
* The content to display in the InfoWindow header row. This can be an HTML
* element, or a string containing HTML. The InfoWindow will be sized
* element, or a string of plain text. The InfoWindow will be sized
* according to the content. To set an explicit size for the header content,
* set headerContent to be a HTML element with that size.
*/
headerContent?: string | Element | Text | null;
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
* Disables the whole header row in the InfoWindow. When set to true, the
* header will be removed so that the header content and the close button
* will be hidden.
Expand Down Expand Up @@ -2873,6 +3007,50 @@ declare namespace google.maps {
*/
pixelOffset: google.maps.Size | null;
}
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
*
* A place that represents a point of reference for the address.
*/
export interface Landmark {
/**
* The name for the landmark.
*/
display_name: string;
/**
* The language of the name for the landmark.
*/
display_name_language_code: string;
/**
* The Place ID of the underlying establishment serving as the landmark. Can
* be used to resolve more information about the landmark through Place
* Details or Place Id Lookup.
*/
place_id: string;
/**
* Defines the spatial relationship between the target location and the
* landmark.
*/
spatial_relationship: google.maps.SpatialRelationship;
/**
* The straight line distance between the target location and the landmark.
*/
straight_line_distance_meters: number;
/**
* The travel distance along the road network between the target location
* and the landmark. This can be unpopulated if the landmark is disconnected
* from the part of the road network the target is closest to OR if the
* target location was not actually considered to be on the road network.
*/
travel_distance_meters?: number;
/**
* One or more values indicating the type of the returned result. Please see
* <a
* href="https://developers.google.com/maps/documentation/places/web-service/supported_types">Types
* </a> for more detail.
*/
types: string[];
}
/**
* A <code>LatLng</code> is a point in geographical coordinates: latitude and
* longitude.<br> <ul> <li>Latitude ranges between -90 and 90 degrees,
Expand Down Expand Up @@ -5951,6 +6129,49 @@ declare namespace google.maps {
*/
width: number;
}
/**
* Available only in the v=beta channel: https://goo.gle/3oAthT3.
*
* An enum representing the relationship in space between the landmark and the
* target.
*
* Access by calling `const {SpatialRelationship} = await
* google.maps.importLibrary("geocoding")`. See
* https://developers.google.com/maps/documentation/javascript/libraries.
*/
export enum SpatialRelationship {
/**
* The target is directly opposite the landmark on the other side of the
* road.
*/
ACROSS_THE_ROAD = 'ACROSS_THE_ROAD',
/**
* Not on the same route as the landmark but a single turn away.
*/
AROUND_THE_CORNER = 'AROUND_THE_CORNER',
/**
* Close to the landmark&#39;s structure but further away from its access
* point.
*/
BEHIND = 'BEHIND',
/**
* The target is directly adjacent to the landmark.
*/
BESIDE = 'BESIDE',
/**
* On the same route as the landmark but not besides or across.
*/
DOWN_THE_ROAD = 'DOWN_THE_ROAD',
/**
* This is the default relationship when nothing more specific below
* applies.
*/
NEAR = 'NEAR',
/**
* The landmark has a spatial geometry and the target is within its bounds.
*/
WITHIN = 'WITHIN',
}
/**
* Options for the rendering of the Street View address control.
*/
Expand Down Expand Up @@ -14661,8 +14882,7 @@ declare namespace google.maps.places {
*/
distanceMeters: number | null;
/**
* Represents additional disambiguating features (such as a city or region)
* to further identify the Place or refine the query.
* Represents the name of the Place.
*/
mainText: google.maps.places.FormattableText | null;
/**
Expand All @@ -14672,12 +14892,17 @@ declare namespace google.maps.places {
placeId: string;
/**
* Represents additional disambiguating features (such as a city or region)
* to further identify the Place or refine the query.
* to further identify the Place.
*/
secondaryText: google.maps.places.FormattableText | null;
/**
* Contains the human-readable name for the returned result. For
* establishment results, this is usually the business name and address.
* <br/><br/> <code>text</code> is recommended for developers who wish to
* show a single UI element. Developers who wish to show two separate, but
* related, UI elements may want to use {@link
* google.maps.places.PlacePrediction.mainText} and {@link
* google.maps.places.PlacePrediction.secondaryText} instead.
*/
text: google.maps.places.FormattableText;
/**
Expand Down