From 1a032b3f2497f87536b57b37b106e4f01cacf7c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20H=C3=A4nisch?= Date: Sat, 19 Oct 2019 00:36:47 +0200 Subject: [PATCH] fix: enums for googlemaps (#39211) * fix: enums for googlemaps * remove deprecated control positions * fix values and ordering of numeric enums --- types/googlemaps/googlemaps-tests.ts | 4 +- types/googlemaps/index.d.ts | 261 ++++++++++++++------------- 2 files changed, 134 insertions(+), 131 deletions(-) diff --git a/types/googlemaps/googlemaps-tests.ts b/types/googlemaps/googlemaps-tests.ts index 3c71e0af9d..f36449ab0e 100644 --- a/types/googlemaps/googlemaps-tests.ts +++ b/types/googlemaps/googlemaps-tests.ts @@ -720,7 +720,7 @@ service.findPlaceFromQuery( fields: ['name'], }, (results, status) => { - if (status === google.maps.places.PlacesServiceStatus.ERROR) { + if (status !== google.maps.places.PlacesServiceStatus.OK) { return; } @@ -734,7 +734,7 @@ service.findPlaceFromPhoneNumber( fields: ['name'], }, (results, status) => { - if (status === google.maps.places.PlacesServiceStatus.ERROR) { + if (status !== google.maps.places.PlacesServiceStatus.OK) { return; } diff --git a/types/googlemaps/index.d.ts b/types/googlemaps/index.d.ts index 3e6712951e..05af7ff998 100644 --- a/types/googlemaps/index.d.ts +++ b/types/googlemaps/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Google Maps JavaScript API 3.37 +// Type definitions for Google Maps JavaScript API 3.38 // Project: https://developers.google.com/maps/ // Definitions by: Chris Wrench , // Kiarash Ghiaseddin , @@ -12,6 +12,7 @@ // Colin Doig // Dmitry Demensky // Vladimir Dashukevich +// Simon Haenisch // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.7 @@ -286,9 +287,11 @@ declare namespace google.maps { } enum MapTypeControlStyle { - DEFAULT, - DROPDOWN_MENU, - HORIZONTAL_BAR, + DEFAULT = 0, + HORIZONTAL_BAR = 1, + DROPDOWN_MENU = 2, + INSET = 3, + INSET_LARGE = 4, } type GestureHandlingOptions = 'cooperative' | 'greedy' | 'none' | 'auto'; @@ -343,7 +346,7 @@ declare namespace google.maps { } enum ScaleControlStyle { - DEFAULT, + DEFAULT = 0, } /** Options for the rendering of the Street View pegman control on the map. */ @@ -370,9 +373,9 @@ declare namespace google.maps { } enum ZoomControlStyle { - DEFAULT, - LARGE, - SMALL, + DEFAULT = 0, + SMALL = 1, + LARGE = 2, } /** @@ -382,44 +385,44 @@ declare namespace google.maps { */ enum ControlPosition { /** Elements are positioned in the center of the bottom row. */ - BOTTOM_CENTER, + BOTTOM_CENTER = 11, /** * Elements are positioned in the bottom left and flow towards the middle. * Elements are positioned to the right of the Google logo. */ - BOTTOM_LEFT, + BOTTOM_LEFT = 10, /** * Elements are positioned in the bottom right and flow towards the middle. * Elements are positioned to the left of the copyrights. */ - BOTTOM_RIGHT, + BOTTOM_RIGHT = 12, /** * Elements are positioned on the left, above bottom-left elements, and flow * upwards. */ - LEFT_BOTTOM, + LEFT_BOTTOM = 6, /** Elements are positioned in the center of the left side. */ - LEFT_CENTER, + LEFT_CENTER = 4, /** * Elements are positioned on the left, below top-left elements, and flow * downwards. */ - LEFT_TOP, + LEFT_TOP = 5, /** * Elements are positioned on the right, above bottom-right elements, and * flow upwards. */ - RIGHT_BOTTOM, + RIGHT_BOTTOM = 9, /** Elements are positioned in the center of the right side. */ - RIGHT_CENTER, + RIGHT_CENTER = 8, /** Elements are positioned on the right, below top-right elements, and flow downwards. */ - RIGHT_TOP, - /** Elements are positioned in the center of the top row. */ - TOP_CENTER, - /** Elements are positioned in the top left and flow towards the middle. */ - TOP_LEFT, + RIGHT_TOP = 7, + /** Elements are positioned in the center of the top row. */ + TOP_CENTER = 2, /** Elements are positioned in the top right and flow towards the middle. */ - TOP_RIGHT, + TOP_LEFT = 1, + /** Elements are positioned in the top right and flow towards the middle. */ + TOP_RIGHT = 3, } type DrawingMode = 'Point' | 'LineString' | 'Polygon'; @@ -1565,11 +1568,11 @@ declare namespace google.maps { * The stroke is centered on the polygon's path, with half the stroke inside * the polygon and half the stroke outside the polygon. */ - CENTER, + CENTER = 0, /** The stroke lies inside the polygon. */ - INSIDE, + INSIDE = 1, /** The stroke lies outside the polygon. */ - OUTSIDE, + OUTSIDE = 2, } class GroundOverlay extends MVCObject { @@ -1674,13 +1677,13 @@ declare namespace google.maps { } enum GeocoderStatus { - ERROR, - INVALID_REQUEST, - OK, - OVER_QUERY_LIMIT, - REQUEST_DENIED, - UNKNOWN_ERROR, - ZERO_RESULTS, + ERROR = 'ERROR', + INVALID_REQUEST = 'INVALID_REQUEST', + OK = 'OK', + OVER_QUERY_LIMIT = 'OVER_QUERY_LIMIT', + REQUEST_DENIED = 'REQUEST_DENIED', + UNKNOWN_ERROR = 'UNKNOWN_ERROR', + ZERO_RESULTS = 'ZERO_RESULTS', } interface GeocoderResult { @@ -1707,10 +1710,10 @@ declare namespace google.maps { } enum GeocoderLocationType { - APPROXIMATE, - GEOMETRIC_CENTER, - RANGE_INTERPOLATED, - ROOFTOP, + APPROXIMATE = 'APPROXIMATE', + GEOMETRIC_CENTER = 'GEOMETRIC_CENTER', + RANGE_INTERPOLATED = 'RANGE_INTERPOLATED', + ROOFTOP = 'ROOFTOP', } class DirectionsRenderer extends MVCObject { @@ -1816,15 +1819,16 @@ declare namespace google.maps { } enum TravelMode { - BICYCLING, - DRIVING, - TRANSIT, - WALKING, + BICYCLING = 'BICYCLING', + DRIVING = 'DRIVING', + TRANSIT = 'TRANSIT', + TWO_WHEELER = 'TWO_WHEELER', + WALKING = 'WALKING', } enum UnitSystem { - IMPERIAL, - METRIC, + METRIC = 0, + IMPERIAL = 1, } interface TransitOptions { @@ -1835,16 +1839,16 @@ declare namespace google.maps { } enum TransitMode { - BUS, - RAIL, - SUBWAY, - TRAIN, - TRAM, + BUS = 'BUS', + RAIL = 'RAIL', + SUBWAY = 'SUBWAY', + TRAIN = 'TRAIN', + TRAM = 'TRAM', } enum TransitRoutePreference { - FEWER_TRANSFERS, - LESS_WALKING, + FEWER_TRANSFERS = 'FEWER_TRANSFERS', + LESS_WALKING = 'LESS_WALKING', } interface TransitFare { @@ -1858,9 +1862,9 @@ declare namespace google.maps { } enum TrafficModel { - BEST_GUESS, - OPTIMISTIC, - PESSIMISTIC, + BEST_GUESS = 'bestguess', + OPTIMISTIC = 'optimistic', + PESSIMISTIC = 'pessimistic', } /** @@ -1888,14 +1892,14 @@ declare namespace google.maps { } enum DirectionsStatus { - INVALID_REQUEST, - MAX_WAYPOINTS_EXCEEDED, - NOT_FOUND, - OK, - OVER_QUERY_LIMIT, - REQUEST_DENIED, - UNKNOWN_ERROR, - ZERO_RESULTS, + INVALID_REQUEST = 'INVALID_REQUEST', + MAX_WAYPOINTS_EXCEEDED = 'MAX_WAYPOINTS_EXCEEDED', + NOT_FOUND = 'NOT_FOUND', + OK = 'OK', + OVER_QUERY_LIMIT = 'OVER_QUERY_LIMIT', + REQUEST_DENIED = 'REQUEST_DENIED', + UNKNOWN_ERROR = 'UNKNOWN_ERROR', + ZERO_RESULTS = 'ZERO_RESULTS', } interface DirectionsResult { @@ -2098,11 +2102,11 @@ declare namespace google.maps { } enum ElevationStatus { - INVALID_REQUEST, - OK, - OVER_QUERY_LIMIT, - REQUEST_DENIED, - UNKNOWN_ERROR, + INVALID_REQUEST = 'INVALID_REQUEST', + OK = 'OK', + OVER_QUERY_LIMIT = 'OVER_QUERY_LIMIT', + REQUEST_DENIED = 'REQUEST_DENIED', + UNKNOWN_ERROR = 'UNKNOWN_ERROR', } class MaxZoomService { @@ -2115,8 +2119,8 @@ declare namespace google.maps { } enum MaxZoomStatus { - ERROR, - OK, + ERROR = 'ERROR', + OK = 'OK', } class DistanceMatrixService { @@ -2159,19 +2163,19 @@ declare namespace google.maps { } enum DistanceMatrixStatus { - INVALID_REQUEST, - MAX_DIMENSIONS_EXCEEDED, - MAX_ELEMENTS_EXCEEDED, - OK, - OVER_QUERY_LIMIT, - REQUEST_DENIED, - UNKNOWN_ERROR, + INVALID_REQUEST = 'INVALID_REQUEST', + MAX_DIMENSIONS_EXCEEDED = 'MAX_DIMENSIONS_EXCEEDED', + MAX_ELEMENTS_EXCEEDED = 'MAX_ELEMENTS_EXCEEDED', + OK = 'OK', + OVER_QUERY_LIMIT = 'OVER_QUERY_LIMIT', + REQUEST_DENIED = 'REQUEST_DENIED', + UNKNOWN_ERROR = 'UNKNOWN_ERROR', } enum DistanceMatrixElementStatus { - NOT_FOUND, - OK, - ZERO_RESULTS, + NOT_FOUND = 'NOT_FOUND', + OK = 'OK', + ZERO_RESULTS = 'ZERO_RESULTS', } /***** Save to Google Maps *****/ @@ -2438,15 +2442,15 @@ declare namespace google.maps { } enum KmlLayerStatus { - DOCUMENT_NOT_FOUND, - DOCUMENT_TOO_LARGE, - FETCH_ERROR, - INVALID_DOCUMENT, - INVALID_REQUEST, - LIMITS_EXCEEDED, - OK, - TIMED_OUT, - UNKNOWN, + DOCUMENT_NOT_FOUND = 'DOCUMENT_NOT_FOUND', + DOCUMENT_TOO_LARGE = 'DOCUMENT_TOO_LARGE', + FETCH_ERROR = 'FETCH_ERROR', + INVALID_DOCUMENT = 'INVALID_DOCUMENT', + INVALID_REQUEST = 'INVALID_REQUEST', + LIMITS_EXCEEDED = 'LIMITS_EXCEEDED', + OK = 'OK', + TIMED_OUT = 'TIMED_OUT', + UNKNOWN = 'UNKNOWN', } interface KmlMouseEvent { @@ -2588,13 +2592,13 @@ declare namespace google.maps { } enum StreetViewPreference { - BEST, - NEAREST, + BEST = 'best', + NEAREST = 'nearest', } enum StreetViewSource { - DEFAULT, - OUTDOOR, + DEFAULT = 'default', + OUTDOOR = 'outdoor', } interface StreetViewLocationRequest { @@ -2625,9 +2629,9 @@ declare namespace google.maps { } enum StreetViewStatus { - OK, - UNKNOWN_ERROR, - ZERO_RESULTS, + OK = 'OK', + UNKNOWN_ERROR = 'UNKNOWN_ERROR', + ZERO_RESULTS = 'ZERO_RESULTS', } class StreetViewCoverageLayer extends MVCObject { @@ -3088,24 +3092,24 @@ declare namespace google.maps { } enum AdFormat { - BANNER, - BUTTON, - HALF_BANNER, - LARGE_HORIZONTAL_LINK_UNIT, - LARGE_RECTANGLE, - LARGE_VERTICAL_LINK_UNIT, - LEADERBOARD, - MEDIUM_RECTANGLE, - MEDIUM_VERTICAL_LINK_UNIT, - SKYSCRAPER, - SMALL_HORIZONTAL_LINK_UNIT, - SMALL_RECTANGLE, - SMALL_SQUARE, - SMALL_VERTICAL_LINK_UNIT, - SQUARE, - VERTICAL_BANNER, - WIDE_SKYSCRAPER, - X_LARGE_VERTICAL_LINK_UNIT, + BANNER = '468x60_as', + BUTTON = '125x125_as', + HALF_BANNER = '234x60_as', + LARGE_HORIZONTAL_LINK_UNIT = '728x15_0ads_al', + LARGE_RECTANGLE = '336x280_as', + LARGE_VERTICAL_LINK_UNIT = '180x90_0ads_al', + LEADERBOARD = '728x90_as', + MEDIUM_RECTANGLE = '300x250_as', + MEDIUM_VERTICAL_LINK_UNIT = '160x90_0ads_al', + SKYSCRAPER = '120x600_as', + SMALL_HORIZONTAL_LINK_UNIT = '468x15_0ads_al', + SMALL_RECTANGLE = '180x150_as', + SMALL_SQUARE = '200x200_as', + SMALL_VERTICAL_LINK_UNIT = '120x90_0ads_al', + SQUARE = '250x250_as', + VERTICAL_BANNER = '120x240_as', + WIDE_SKYSCRAPER = '160x600_as', + X_LARGE_VERTICAL_LINK_UNIT = '200x90_0ads_al', } } @@ -3337,14 +3341,13 @@ declare namespace google.maps { } enum PlacesServiceStatus { - ERROR, - INVALID_REQUEST, - OK, - OVER_QUERY_LIMIT, - NOT_FOUND, - REQUEST_DENIED, - UNKNOWN_ERROR, - ZERO_RESULTS, + INVALID_REQUEST = 'INVALID_REQUEST', + NOT_FOUND = 'NOT_FOUND', + OK = 'OK', + OVER_QUERY_LIMIT = 'OVER_QUERY_LIMIT', + REQUEST_DENIED = 'REQUEST_DENIED', + UNKNOWN_ERROR = 'UNKNOWN_ERROR', + ZERO_RESULTS = 'ZERO_RESULTS', } interface QueryAutocompletePrediction { @@ -3373,8 +3376,8 @@ declare namespace google.maps { } enum RankBy { - DISTANCE, - PROMINENCE, + PROMINENCE = 0, + DISTANCE = 1, } class SearchBox extends MVCObject { @@ -3497,27 +3500,27 @@ declare namespace google.maps { * Specifies that the DrawingManager creates circles, and that the overlay * given in the overlaycomplete event is a circle. */ - CIRCLE, + CIRCLE = 'circle', /** * Specifies that the DrawingManager creates markers, and that the overlay * given in the overlaycomplete event is a marker. */ - MARKER, + MARKER = 'marker', /** * Specifies that the DrawingManager creates polygons, and that the * overlay given in the overlaycomplete event is a polygon. */ - POLYGON, + POLYGON = 'polygon', /** * Specifies that the DrawingManager creates polylines, and that the * overlay given in the overlaycomplete event is a polyline. */ - POLYLINE, + POLYLINE = 'polyline', /** * Specifies that the DrawingManager creates rectangles, and that the * overlay given in the overlaycomplete event is a rectangle. */ - RECTANGLE, + RECTANGLE = 'rectangle', } } @@ -3567,9 +3570,9 @@ declare namespace google.maps { } enum MapsEngineStatus { - INVALID_LAYER, - OK, - UNKNOWN_ERROR, + INVALID_LAYER = 'INVALID_LAYER', + OK = 'OK', + UNKNOWN_ERROR = 'UNKNOWN_ERROR', } class HeatmapLayer extends MVCObject {