Use Google Maps Place data in templates (#294)

* Fill in templates with Google Maps places data

* Fill in templates with Google Maps places data

* simplify lookups

* Updating docs

* fixes

* fixes

* Small PR comments

* Google maps result typing and empty string if undefined

* fixes

Author: HalFrgrd

README.md

@@ -5,7 +5,7 @@
 <!--ts-->
 
 <!-- Created by https://github.com/ekalinin/github-markdown-toc -->
-<!-- Added by: erez, at: Sun 03 Nov 2024 12:07:11 IST -->
+<!-- Added by: hal, at: Sun 22 Dec 12:58:47 GMT 2024 -->
 
 <!--te-->
 
@@ -232,6 +232,19 @@ Map View adds an Obsidian command named "New geolocation note", which you can ma
 
 This opens a dialog on which you can search (address or location based on your [configured geocoding provider](#changing-a-geocoding-provider)) or paste a URL using the built-in or custom [URL parsing rules](#url-parsing-rules).
 
+When using Google Maps Places API, templates can extract additional result data.
+For instance, templates that match `googleMapsPlaceData.some.path` will be replaced with the value found at `some.path` in the [JSON serach result](https://developers.google.com/maps/documentation/places/web-service/place-data-fields).
+For instance, the following template would set a [place_id](https://developers.google.com/maps/documentation/places/web-service/place-id) property and tags the note with the [type](https://developers.google.com/maps/documentation/places/web-service/supported_types) of the place:
+
+```
+---
+place_id: "{{googleMapsPlaceData.place_id}}"
+---
+#{{googleMapsPlaceData.types.0}}
+```
+
+Currently only Google Maps Places API supports this advanced templating feature.
+
 ![](img/new-note-popup.gif)
 
 ### In an Existing Note

package.json

@@ -21,6 +21,7 @@
         "@rollup/plugin-node-resolve": "^11.2.1",
         "@rollup/plugin-typescript": "^8.2.1",
         "@types/geojson": "^7946.0.7",
+        "@types/google.maps": "^3.58.1",
         "@types/leaflet": "^1.9.3",
         "@types/leaflet.markercluster": "^1.4.5",
         "@types/node": "^14.14.37",

src/geosearch.ts

@@ -7,6 +7,7 @@ import { PluginSettings } from 'src/settings';
 import { UrlConvertor } from 'src/urlConvertor';
 import { FileMarker } from 'src/markers';
 import * as consts from 'src/consts';
+import * as utils from 'src/utils';
 
 /**
  * A generic result of a geosearch
@@ -17,6 +18,7 @@ export class GeoSearchResult {
     location: leaflet.LatLng;
     resultType: 'searchResult' | 'url' | 'existingMarker';
     existingMarker?: FileMarker;
+    extraLocationData?: utils.ExtraLocationData;
 }
 
 export class GeoSearcher {
@@ -76,6 +78,7 @@ export class GeoSearcher {
                         name: result.name,
                         location: result.location,
                         resultType: 'searchResult',
+                        extraLocationData: result.extraLocationData,
                     });
             } catch (e) {
                 console.log(
@@ -129,7 +132,7 @@ export async function googlePlacesSearch(
         'https://maps.googleapis.com/maps/api/place/textsearch/json?' +
         querystring.stringify(params);
     const googleContent = await request({ url: googleUrl });
-    const jsonContent = JSON.parse(googleContent) as any;
+    const jsonContent = JSON.parse(googleContent);
     let results: GeoSearchResult[] = [];
     if (
         jsonContent &&
@@ -147,6 +150,7 @@ export async function googlePlacesSearch(
                     name: `${result?.name} (${result?.formatted_address})`,
                     location: geolocation,
                     resultType: 'searchResult',
+                    extraLocationData: { googleMapsPlaceData: result },
                 } as GeoSearchResult);
             }
         }

src/locationSearchDialog.ts

@@ -143,7 +143,8 @@ export class LocationSearchDialog extends SuggestModal<SuggestInfo> {
             this.plugin.newFrontMatterNote(
                 value.location,
                 evt,
-                utils.sanitizePlaceNameForNoteName(value.name)
+                utils.sanitizePlaceNameForNoteName(value.name),
+                value.extraLocationData
             );
         else if (this.dialogAction == 'addToNote')
             this.addToNote(value.location, evt, value.name);

src/main.ts

@@ -118,7 +118,7 @@ export default class MapViewPlugin extends Plugin {
                                   )
                                 : null;
                         if (location) {
-                            this.newFrontMatterNote(location, null, label);
+                            this.newFrontMatterNote(location, null, label, {});
                         }
                     } else if (params.mvaction === 'addtocurrentnotefm') {
                         const location =
@@ -919,7 +919,8 @@ export default class MapViewPlugin extends Plugin {
     async newFrontMatterNote(
         location: leaflet.LatLng,
         ev: MouseEvent | KeyboardEvent | null,
-        query: string
+        query: string,
+        extraLocationData: utils.ExtraLocationData
     ) {
         const locationString = `${location.lat},${location.lng}`;
         const newFileName = utils.formatWithTemplates(
@@ -933,7 +934,8 @@ export default class MapViewPlugin extends Plugin {
             newFileName,
             locationString,
             this.settings.frontMatterKey,
-            this.settings.newNoteTemplate
+            this.settings.newNoteTemplate,
+            extraLocationData
         );
         // If there is an open map view, use it to decide how and where to open the file.
         // Otherwise, open the file from the active leaf

src/utils.ts

@@ -41,16 +41,48 @@ export function getLastUsedValidMarkdownLeaf() {
     return null;
 }
 
-export function formatWithTemplates(s: string, query = '') {
+function resolveJsonPath(json: object, path: string): string | undefined {
+    // Convert a string path like "some.path.to.data.0" to the value at that path in JSON
+    // Remove leading/trailing curly braces and split the path into parts
+    const pathParts = path.replace(/[{}]/g, '').split('.');
+    // Use reduce with optional chaining to traverse the path
+    return pathParts.reduce((current, part) => (current as any)?.[part], json);
+}
+
+export type ExtraLocationData = {
+    googleMapsPlaceData?: google.maps.places.PlaceResult;
+};
+
+function replaceJsonPaths(content: string, json: ExtraLocationData) {
+    // Use regex to find all patterns like {{some.path.to.data.0}}
+
+    // Find patterns to replace that start with an attribute of json
+    for (const [key, data] of Object.entries(json)) {
+        const regex = new RegExp(`{{${key}\\.(.*?)}}`, 'g');
+        return content.replace(regex, (_, path: string) => {
+            const result = resolveJsonPath(data, path);
+            return result ? result : '';
+        });
+    }
+    return content;
+}
+
+export function formatWithTemplates(
+    s: string,
+    query = '',
+    extraLocationData: ExtraLocationData = {}
+) {
     const datePattern = /{{date:([a-zA-Z\-\/\.\:]*)}}/g;
     const queryPattern = /{{query}}/g;
-    const replaced = s
+    let replaced = s
         .replace(datePattern, (_, pattern) => {
             // @ts-ignore
             return moment().format(pattern);
         })
         .replace(queryPattern, query);
 
+    replaced = replaceJsonPaths(replaced, extraLocationData);
+
     return replaced;
 }
 
@@ -101,11 +133,19 @@ export async function newNote(
     fileName: string,
     location: string,
     frontMatterKey: string,
-    templatePath?: string
+    templatePath: string,
+    extraLocationData?: ExtraLocationData
 ): Promise<[TFile, number]> {
     let templateContent = '';
     if (templatePath && templatePath.length > 0)
         templateContent = await app.vault.adapter.read(templatePath);
+
+    templateContent = formatWithTemplates(
+        templateContent,
+        '',
+        extraLocationData
+    );
+
     const templateFrontMatterInfo = getFrontMatterInfo(templateContent);
 
     let newFrontMatterContents;