fix!: finalize library as 100% compatibility shim by dkhawk · Pull Request #306 · googlemaps/android-places-ktx

dkhawk · 2026-02-27T16:10:46Z

This PR completes the transformation of the library into a 100% compatibility shim.

Key Changes:

API Realignment: Moved APIs to match official SDK conventions (e.g., , ).
Complete Deprecation: All remaining custom KTX APIs are now and delegate to the core SDK (including and model builders).
Build Stabilization: Reverted IR-crashing shims to manual Builder calls to ensure build stability while maintaining the deprecation interface.
Modernized Demo App: Added a comprehensive, modernized Places Photo demo using Compose, Material 3, and Hilt, with extensive pedagogical documentation.
Migration Guide: Created and refined with explicit instructions and examples for removing the KTX dependency.

…ality

…holders

kikoso · 2026-02-27T16:59:02Z

Just as a comment: this will trigger a 5.0.0 version.

…hotoUri

...rc/test/java/com/google/android/libraries/places/ktx/api/net/SearchNearbyPlaceRequestTest.kt

yuhan1212 · 2026-02-27T17:41:27Z

MIGRATION_GUIDE.md

+
+While this library is now primarily a compatibility shim, it still provides a few minor Kotlin-specific conveniences not yet present in the core SDK:
+
+1.  **DSL Builders**: Lightweight Kotlin DSL builders for models (e.g., `place { ... }`, `photoMetadata { ... }`).


There is Kotlin wrapper for models like Place and PhotoMetadata

https://developers.google.com/maps/documentation/places/android-sdk/reference/com/google/android/libraries/places/api/model/kotlin/PlaceKt

https://developers.google.com/maps/documentation/places/android-sdk/reference/com/google/android/libraries/places/api/model/kotlin/PhotoMetadataKt

yuhan1212 · 2026-02-27T17:45:55Z

MIGRATION_GUIDE.md

+
+1.  **DSL Builders**: Lightweight Kotlin DSL builders for models (e.g., `place { ... }`, `photoMetadata { ... }`).
+2.  **PriceLevel Enum**: A type-safe `PriceLevel` enum for `SearchByTextRequest` filtering.
+3.  **SearchNearby Support**: Helper for `searchNearbyPlaceRequest` with a simplified API.


Kotlin wrapper for SearchNearbyRequest is provided.

https://developers.google.com/maps/documentation/places/android-sdk/reference/com/google/android/libraries/places/api/net/kotlin/SearchNearbyRequestKt

We should call it SearchNearbyRequest (no 'place') to be consist with the name in SDK.

yuhan1212 · 2026-02-27T17:47:28Z

MIGRATION_GUIDE.md

+The entire `AutocompleteSupportFragment.kt` file has been deleted.
+- **Removed**: `AutocompleteSupportFragment.placeSelectionEvents()`
+- **Removed**: `PlaceSelectionResult`, `PlaceSelectionSuccess`, and `PlaceSelectionError` classes.
+- **Migration**: Use the official SDK's `AutocompleteSupportFragment` or migrate to the Compose-based patterns shown in the demo app.


The AutocompleteSupportFragment is deprecated. Use com.google.android.libraries.places.widget.PlaceAutocompleteActivity instead.

https://developers.google.com/maps/documentation/places/android-sdk/reference/com/google/android/libraries/places/widget/AutocompleteSupportFragment

yuhan1212 · 2026-02-27T17:48:40Z

MIGRATION_GUIDE.md

+| Old File | New File | API Maintained |
+| :--- | :--- | :--- |
+| `FetchPhotoRequest.kt` | `FetchResolvedPhotoUriRequest.kt` | `fetchResolvedPhotoUriRequest` |
+| `FindCurrentPlaceRequest.kt` | `SearchNearbyRequest.kt` | `searchNearbyPlaceRequest` |


searchNearbyRequest instead of searchNearbyPlaceRequest to be consist with the name in the SDK

yuhan1212 · 2026-02-27T17:52:57Z

MIGRATION_GUIDE.md

+| File | API |
+| :--- | :--- |
+| **`PlacesClient.kt`** | `awaitFetchPlace`, `awaitFetchResolvedPhotoUri`, `awaitFindAutocompletePredictions`, `awaitSearchNearby`, `awaitIsOpen`, `awaitSearchByText` |
+| **DSL Builders** | `fetchPlaceRequest`, `findAutocompletePredictionsRequest`, `isOpenRequest`, `searchByTextRequest` |


Should we also list the newly added fetchResolvedPhotoUriRequest and searchNearbyRequest here?

…uilders

…earchNearby demo

yuhan1212

I reviewed those files related to Places SDK usage.

yuhan1212 · 2026-02-27T22:19:04Z

places-ktx/src/main/java/com/google/android/libraries/places/ktx/api/model/OpeningHours.kt

Can this also import and use the kotlin wrapper from SDK?

Nope. Unfortunately, it causes the Kotlin compiler to crash. Not worth fixing for a library that is going to be archived.

public fun openingHours(actions: OpeningHours.Builder.() -> Unit): OpeningHours { return com.google.android.libraries.places.api.model.kotlin.openingHours(actions) }

results in this crash from the compiler

java.lang.RuntimeException: Exception while generating code for: FUN name:openingHours visibility:public modality:FINAL returnType:com.google.android.libraries.places.api.model.OpeningHours VALUE_PARAMETER kind:Regular name:actions index:0 type:@[ExtensionFunctionType] kotlin.Function1<com.google.android.libraries.places.api.model.OpeningHours.Builder, kotlin.Unit> annotations: Deprecated(message = "Use the version in the Places SDK instead.", replaceWith = ReplaceWith(expression = "openingHours(actions)", imports = ["com.google.android.libraries.places.api.model.kotlin.openingHours"] type=kotlin.Array<out kotlin.String> varargElementType=kotlin.String), level = <null>) BLOCK_BODY RETURN type=kotlin.Nothing from='public final fun openingHours (actions: @[ExtensionFunctionType] kotlin.Function1<com.google.android.libraries.places.api.model.OpeningHours.Builder, kotlin.Unit>): com.google.android.libraries.places.api.model.OpeningHours declared in com.google.android.libraries.places.ktx.api.model.OpeningHoursKt' CALL 'public final fun openingHours (actions: @[ExtensionFunctionType] kotlin.Function1<com.google.android.libraries.places.api.model.OpeningHours.Builder, kotlin.Unit>): com.google.android.libraries.places.api.model.OpeningHours [inline] declared in com.google.android.libraries.places.api.model.kotlin.OpeningHoursKt' type=com.google.android.libraries.places.api.model.OpeningHours origin=null ARG actions: GET_VAR 'actions: @[ExtensionFunctionType] kotlin.Function1<com.google.android.libraries.places.api.model.OpeningHours.Builder, kotlin.Unit> declared in com.google.android.libraries.places.ktx.api.model.OpeningHoursKt.openingHours' type=@[ExtensionFunctionType] kotlin.Function1<com.google.android.libraries.places.api.model.OpeningHours.Builder, kotlin.Unit> origin=null at org.jetbrains.kotlin.backend.jvm.codegen.FunctionCodegen.generate(FunctionCodegen.kt:50) at org.jetbrains.kotlin.backend.jvm.codegen.FunctionCodegen.generate$default(FunctionCodegen.kt:43) at org.jetbrains.kotlin.backend.jvm.codegen.ClassCodegen.generateMethodNode(ClassCodegen.kt:422) at org.jetbrains.kotlin.backend.jvm.codegen.ClassCodegen.generateMethod(ClassCodegen.kt:439) at org.jetbrains.kotlin.backend.jvm.codegen.ClassCodegen.generate(ClassCodegen.kt:164)

yuhan1212 · 2026-02-27T22:19:09Z

places-ktx/src/main/java/com/google/android/libraries/places/ktx/api/model/Period.kt

Can this also import and use the kotlin wrapper from SDK?

Same problem with the compiler crash

yuhan1212 · 2026-02-27T22:19:26Z

places-ktx/src/main/java/com/google/android/libraries/places/ktx/api/model/Place.kt

Can this also import and use the kotlin wrapper from SDK?

Same problem with the compiler crash

yuhan1212 · 2026-02-27T22:20:06Z

places-ktx/src/main/java/com/google/android/libraries/places/ktx/api/model/PlusCode.kt

This imports sdkPlusCode but it doesn't use it.

Same problem with the compiler crash

(But I missed the extra import. Thanks!)

yuhan1212 · 2026-02-27T22:21:55Z

...n/java/com/google/android/libraries/places/ktx/api/net/FindAutocompletePredictionsRequest.kt

Do you want to make it consist to import it as sdkFindAutocompletePredictionsRequest as other files do?

yuhan1212 · 2026-02-27T22:22:53Z

places-ktx/src/main/java/com/google/android/libraries/places/ktx/api/net/PlacesClient.kt

@@ -1,4 +1,4 @@
-// Copyright 2026 Google LLC
+// Copyright 2020 Google LLC


Is this intended?

Yes. The date was accidently updated in the previous commit

yuhan1212 · 2026-02-27T22:26:40Z

places-ktx/src/main/java/com/google/android/libraries/places/ktx/api/net/SearchByTextRequest.kt

  actions: SearchByTextRequest.Builder.() -> Unit = {},
 ): SearchByTextRequest {
-  return sdkSearchByTextRequest(textQuery, placeFields, actions)
+  return com.google.android.libraries.places.api.net.kotlin.searchByTextRequest(textQuery, placeFields, actions)


Can we import it as sdkSearchByTextRequest as how other files do?

- Standardize on the 'sdk*' naming convention for official SDK Kotlin delegation imports. - Update FindAutocompletePredictionsRequest and SearchByTextRequest to use explicit delegation aliases. - Remove redundant 'sdkPlusCode' alias in PlusCode.kt and cleanup imports.

refactor!: remove redundant and deprecated request wrappers

d849b86

dkhawk requested review from kikoso and yuhan1212 February 27, 2026 16:10

dkhawk marked this pull request as draft February 27, 2026 16:13

dkhawk added 6 commits February 27, 2026 09:19

docs: add detailed API changes to migration guide

32e60c1

docs: add icebox and archival notice to migration guide

1df08fc

docs: use release-please placeholders and document remaining function…

77f8024

…ality

docs: add archival notice to README and refine migration guide

5e478b0

docs: add archival notice to README and cleanup migration guide place…

e5e65ee

…holders

docs: indicate v4.0.0 and beyond in migration guide

93fb57a

dkhawk changed the title ~~refactor!: remove redundant and deprecated request wrappers~~ fix!: remove redundant and deprecated request wrappers Feb 27, 2026

docs: incorporate review recommendations into migration guide

2bb2aaa

feat!: add Places Photo Demo activity to showcase awaitFetchResolvedP…

84e0391

…hotoUri

yuhan1212 reviewed Feb 27, 2026

View reviewed changes

dkhawk added 8 commits February 27, 2026 11:54

refactor!: align shim naming with SDK and deprecate redundant model b…

9896d28

…uilders

docs: pedagogical documentation for demo and stabilization of shims

5db1c6d

docs: suggest custom enum for PriceLevel migration

a0539a0

docs: add regional variance note to PriceLevel

84f817c

fix: restore broken KDoc syntax in SearchByTextRequest.kt

96fe22d

docs: refine PriceLevel migration guide description

e02b63b

docs: revert incorrect copyright year updates for existing files

7d7a6d7

dkhawk changed the title ~~fix!: remove redundant and deprecated request wrappers~~ fix!: finalize library as 100% compatibility shim Feb 27, 2026

dkhawk marked this pull request as ready for review February 27, 2026 20:01

dkhawk added 3 commits February 27, 2026 14:36

refactor!: delegate to official SDK Kotlin extensions and modernize S…

942faf1

…earchNearby demo

docs: use relative links in migration guide for github compatibility

db8948e

build(deps): update mockito and runtime versions

6e877b0

dkhawk requested a review from yuhan1212 February 27, 2026 21:55

yuhan1212 reviewed Feb 27, 2026

View reviewed changes

dkhawk requested a review from yuhan1212 February 28, 2026 01:05


		While this library is now primarily a compatibility shim, it still provides a few minor Kotlin-specific conveniences not yet present in the core SDK:

		1. DSL Builders: Lightweight Kotlin DSL builders for models (e.g., `place { ... }`, `photoMetadata { ... }`).

		@@ -1,4 +1,4 @@
		// Copyright 2026 Google LLC
		// Copyright 2020 Google LLC

Conversation

dkhawk commented Feb 27, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Key Changes:

Uh oh!

kikoso commented Feb 27, 2026

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

yuhan1212 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dkhawk commented Feb 27, 2026 •

edited

Loading