@ttoss/google-maps 1.16.0 → 1.20.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ttoss/google-maps",
-  "version": "1.16.0",
+  "version": "1.20.0",
   "author": "ttoss",
   "contributors": [
     {
@@ -31,13 +31,17 @@
     "build": "tsup"
   },
   "dependencies": {
-    "@ttoss/hooks": "^1.16.0",
+    "@ttoss/hooks": "^1.20.0",
     "@types/google.maps": "^3.48.6",
     "use-callback-ref": "^1.3.0"
   },
+  "devDependencies": {
+    "@ttoss/config": "^1.17.0",
+    "@ttoss/test-utils": "^1.16.6"
+  },
   "peerDependencies": {
     "react": ">=16.8.0",
     "react-dom": ">=16.8.0"
   },
-  "gitHead": "0412266ba0223a5b42904254a13d96473006e0a3"
+  "gitHead": "bea31ace95128d57607156807e402a793b0c46e4"
 }

package/src/index.spec.ts

@@ -5,4 +5,5 @@ test('should export all methods', () => {
   expect(googleMaps.useGeocoder).toBeDefined();
   expect(googleMaps.useGoogleMaps).toBeDefined();
   expect(googleMaps.useMap).toBeDefined();
+  expect(googleMaps.usePlacesAutocomplete).toBeDefined();
 });

package/src/index.ts

@@ -1,3 +1,4 @@
 export { GoogleMapsProvider, useGoogleMaps } from './GoogleMapsProvider';
 export { useGeocoder } from './useGeocoder';
 export { useMap } from './useMap';
+export { usePlacesAutocomplete } from './usePlacesAutocomplete';

package/src/usePlacesAutocomplete/debounce.ts

@@ -0,0 +1,20 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const debounce = <F extends (...args: any[]) => void>(
+  fn: F,
+  delay: number
+): ((this: ThisParameterType<F>, ...args: Parameters<F>) => void) => {
+  let timer: ReturnType<typeof setTimeout> | null;
+
+  function debounceFn(this: ThisParameterType<F>, ...args: Parameters<F>) {
+    if (timer !== null) {
+      clearTimeout(timer);
+      timer = null;
+    }
+
+    timer = setTimeout(() => fn.apply(this, args), delay);
+  }
+
+  return debounceFn;
+};
+
+export default debounce;

package/src/usePlacesAutocomplete/index.ts

@@ -0,0 +1,192 @@
+/* eslint-disable react-hooks/exhaustive-deps */
+import { useGoogleMaps } from './../GoogleMapsProvider';
+
+import { useCallback, useEffect, useRef, useState } from 'react';
+
+import _debounce from './debounce';
+import useLatest from './useLatest';
+
+export interface HookArgs {
+  requestOptions?: Omit<google.maps.places.AutocompletionRequest, 'input'>;
+  debounce?: number;
+  cache?: number | false;
+  cacheKey?: string;
+  callbackName?: string;
+  defaultValue?: string;
+  initOnMount?: boolean;
+}
+
+type Suggestion = google.maps.places.AutocompletePrediction;
+
+type Status = `${google.maps.places.PlacesServiceStatus}` | '';
+
+interface Suggestions {
+  readonly loading: boolean;
+  readonly status: Status;
+  data: Suggestion[];
+}
+
+interface SetValue {
+  (val: string, shouldFetchData?: boolean): void;
+}
+
+interface HookReturn {
+  ready: boolean;
+  value: string;
+  suggestions: Suggestions;
+  setValue: SetValue;
+  clearSuggestions: () => void;
+  clearCache: () => void;
+  init: () => void;
+}
+
+export const loadApiErr = '💡 Google Maps Places API library must be loaded.';
+
+export const usePlacesAutocomplete = ({
+  requestOptions,
+  debounce = 200,
+  cache = 24 * 60 * 60,
+  cacheKey,
+  callbackName,
+  defaultValue = '',
+  initOnMount = true,
+}: HookArgs = {}): HookReturn => {
+  const [ready, setReady] = useState(false);
+  const [value, setVal] = useState(defaultValue);
+  const [suggestions, setSuggestions] = useState<Suggestions>({
+    loading: false,
+    status: '',
+    data: [],
+  });
+  const asRef = useRef<any>(null);
+  const requestOptionsRef = useLatest(requestOptions);
+  const { googleMaps } = useGoogleMaps();
+
+  const googleMapsRef = useLatest(googleMaps);
+
+  const upaCacheKey = cacheKey ? `upa-${cacheKey}` : 'upa';
+
+  const init = useCallback(() => {
+    if (asRef.current) return;
+
+    if (!googleMaps) {
+      return;
+    }
+
+    const { current: gMaps } = googleMapsRef;
+    const placesLib = gMaps?.places || googleMaps.places;
+
+    if (!placesLib) {
+      return;
+    }
+
+    asRef.current = new placesLib.AutocompleteService();
+    setReady(true);
+  }, [googleMaps]);
+
+  const clearSuggestions = useCallback(() => {
+    setSuggestions({ loading: false, status: '', data: [] });
+  }, []);
+
+  const clearCache = useCallback(() => {
+    try {
+      sessionStorage.removeItem(upaCacheKey);
+    } catch (error) {
+      // Skip exception
+    }
+  }, []);
+
+  const fetchPredictions = useCallback(
+    _debounce((val: string) => {
+      if (!val) {
+        clearSuggestions();
+        return;
+      }
+
+      setSuggestions((prevState) => ({ ...prevState, loading: true }));
+
+      let cachedData: Record<string, { data: Suggestion[]; maxAge: number }> =
+        {};
+
+      try {
+        cachedData = JSON.parse(sessionStorage.getItem(upaCacheKey) || '{}');
+      } catch (error) {
+        // Skip exception
+      }
+
+      if (cache) {
+        cachedData = Object.keys(cachedData).reduce(
+          (acc: typeof cachedData, key) => {
+            if (cachedData[key].maxAge - Date.now() >= 0)
+              acc[key] = cachedData[key];
+            return acc;
+          },
+          {}
+        );
+
+        if (cachedData[val]) {
+          setSuggestions({
+            loading: false,
+            status: 'OK',
+            data: cachedData[val].data,
+          });
+          return;
+        }
+      }
+
+      asRef?.current?.getPlacePredictions(
+        { ...requestOptionsRef.current, input: val },
+        (data: Suggestion[] | null, status: Status) => {
+          setSuggestions({ loading: false, status, data: data || [] });
+
+          if (cache && status === 'OK') {
+            cachedData[val] = {
+              data: data as Suggestion[],
+              maxAge: Date.now() + cache * 1000,
+            };
+
+            try {
+              sessionStorage.setItem(upaCacheKey, JSON.stringify(cachedData));
+            } catch (error) {
+              // Skip exception
+            }
+          }
+        }
+      );
+    }, debounce),
+    [debounce, clearSuggestions]
+  );
+
+  const setValue: SetValue = useCallback(
+    (val, shouldFetchData = true) => {
+      setVal(val);
+      if (asRef.current && shouldFetchData) fetchPredictions(val);
+    },
+    [fetchPredictions]
+  );
+
+  useEffect(() => {
+    if (!initOnMount) return () => null;
+
+    if (!googleMapsRef.current && !googleMaps && callbackName) {
+      (window as any)[callbackName] = init;
+    } else {
+      init();
+    }
+
+    return () => {
+      if ((window as any)[callbackName as string])
+        delete (window as any)[callbackName as string];
+    };
+  }, [callbackName, init]);
+
+  return {
+    ready,
+    value,
+    suggestions,
+    setValue,
+    clearSuggestions,
+    clearCache,
+    init,
+  };
+};

package/src/usePlacesAutocomplete/useLatest.ts

@@ -0,0 +1,7 @@
+import { RefObject, useRef } from 'react';
+
+export default <T>(val: T): RefObject<T> => {
+  const ref = useRef(val);
+  ref.current = val;
+  return ref;
+};

package/dist/esm/index.js

@@ -1,98 +0,0 @@
-// tsup.inject.js
-import * as React from "react";
-
-// src/GoogleMapsProvider.tsx
-import * as React2 from "react";
-import { useScript } from "@ttoss/hooks";
-var GoogleMapsContext = React2.createContext({
-  status: "idle",
-  googleMaps: null
-});
-var GoogleMapsProvider = ({
-  children,
-  apiKey,
-  libraries,
-  language
-}) => {
-  const src = (() => {
-    let srcTemp = `https://maps.googleapis.com/maps/api/js?key=${apiKey}`;
-    if (libraries) {
-      srcTemp = srcTemp + `&libraries=${libraries.join(",")}`;
-    }
-    if (language) {
-      srcTemp = srcTemp + `&language=${language}`;
-    }
-    return srcTemp;
-  })();
-  const { status } = useScript(src);
-  const googleMaps = React2.useMemo(() => {
-    if (status === "ready" && window.google.maps) {
-      return window.google.maps;
-    }
-    return null;
-  }, [status]);
-  const value = React2.useMemo(() => {
-    if (status === "ready" && googleMaps) {
-      return {
-        status,
-        googleMaps
-      };
-    }
-    return {
-      status,
-      googleMaps: null
-    };
-  }, [googleMaps, status]);
-  return /* @__PURE__ */ React2.createElement(GoogleMapsContext.Provider, {
-    value
-  }, children);
-};
-var useGoogleMaps = () => React2.useContext(GoogleMapsContext);
-
-// src/useGeocoder.ts
-import * as React3 from "react";
-var useGeocoder = () => {
-  const { googleMaps } = useGoogleMaps();
-  const [isGeocoderInitialized, setIsGeocoderInitialized] = React3.useState(false);
-  const geocoder = React3.useMemo(() => {
-    if (googleMaps) {
-      const googleMapsGeocoder = new googleMaps.Geocoder();
-      setIsGeocoderInitialized(true);
-      return googleMapsGeocoder;
-    }
-    return null;
-  }, [googleMaps]);
-  return { geocoder, isGeocoderInitialized };
-};
-
-// src/useMap.ts
-import * as React4 from "react";
-import { useCallbackRef } from "use-callback-ref";
-var useMap = (options = {}) => {
-  const [, forceUpdate] = React4.useState(0);
-  const ref = useCallbackRef(null, () => forceUpdate((n) => n + 1));
-  const { googleMaps } = useGoogleMaps();
-  const map = React4.useMemo(() => {
-    if (googleMaps && ref.current) {
-      return new googleMaps.Map(ref.current, options);
-    }
-    return null;
-  }, [googleMaps, ref.current]);
-  const optionsStringify = JSON.stringify(options);
-  React4.useEffect(() => {
-    if (map) {
-      const parsedOptions = JSON.parse(optionsStringify);
-      map.setOptions(parsedOptions);
-    }
-  }, [optionsStringify, map]);
-  return {
-    map,
-    ref
-  };
-};
-export {
-  GoogleMapsProvider,
-  useGeocoder,
-  useGoogleMaps,
-  useMap
-};

package/dist/index.d.ts

@@ -1,47 +0,0 @@
-import * as React from 'react';
-import { ScriptStatus } from '@ttoss/hooks';
-
-declare type Extends<T, U extends T> = U;
-declare type GoogleMaps = typeof google.maps;
-declare type LoadedMapsStatus = Extends<ScriptStatus, 'ready'>;
-declare type NotLoadedMapStatus = Extends<ScriptStatus, 'idle' | 'error' | 'loading'>;
-declare type Libraries = 'places' | 'visualization' | 'drawing' | 'geometry';
-declare const GoogleMapsProvider: ({ children, apiKey, libraries, language, }: {
-    children: React.ReactNode;
-    apiKey: string;
-    libraries?: Libraries[] | undefined;
-    /**
-     * https://developers.google.com/maps/faq#languagesupport
-     */
-    language?: string | undefined;
-}) => JSX.Element;
-/**
- *
- * @returns param.googleMaps: GoogleMaps - returns the google maps object which
- * provides access to the [Google Maps API](https://developers.google.com/maps/documentation/javascript/overview).
- */
-declare const useGoogleMaps: () => {
-    status: LoadedMapsStatus;
-    googleMaps: GoogleMaps;
-} | {
-    status: NotLoadedMapStatus;
-    googleMaps: null;
-};
-
-declare const useGeocoder: () => {
-    geocoder: google.maps.Geocoder | null;
-    isGeocoderInitialized: boolean;
-};
-
-declare const useMap: (options?: google.maps.MapOptions) => {
-    /**
-     * asss
-     */
-    map: google.maps.Map | null;
-    /**
-     * hhhh
-     */
-    ref: React.MutableRefObject<HTMLDivElement | null>;
-};
-
-export { GoogleMapsProvider, useGeocoder, useGoogleMaps, useMap };

package/dist/index.js

@@ -1,130 +0,0 @@
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target, mod));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  GoogleMapsProvider: () => GoogleMapsProvider,
-  useGeocoder: () => useGeocoder,
-  useGoogleMaps: () => useGoogleMaps,
-  useMap: () => useMap
-});
-module.exports = __toCommonJS(src_exports);
-
-// tsup.inject.js
-var React = __toESM(require("react"));
-
-// src/GoogleMapsProvider.tsx
-var React2 = __toESM(require("react"));
-var import_hooks = require("@ttoss/hooks");
-var GoogleMapsContext = React2.createContext({
-  status: "idle",
-  googleMaps: null
-});
-var GoogleMapsProvider = ({
-  children,
-  apiKey,
-  libraries,
-  language
-}) => {
-  const src = (() => {
-    let srcTemp = `https://maps.googleapis.com/maps/api/js?key=${apiKey}`;
-    if (libraries) {
-      srcTemp = srcTemp + `&libraries=${libraries.join(",")}`;
-    }
-    if (language) {
-      srcTemp = srcTemp + `&language=${language}`;
-    }
-    return srcTemp;
-  })();
-  const { status } = (0, import_hooks.useScript)(src);
-  const googleMaps = React2.useMemo(() => {
-    if (status === "ready" && window.google.maps) {
-      return window.google.maps;
-    }
-    return null;
-  }, [status]);
-  const value = React2.useMemo(() => {
-    if (status === "ready" && googleMaps) {
-      return {
-        status,
-        googleMaps
-      };
-    }
-    return {
-      status,
-      googleMaps: null
-    };
-  }, [googleMaps, status]);
-  return /* @__PURE__ */ React2.createElement(GoogleMapsContext.Provider, {
-    value
-  }, children);
-};
-var useGoogleMaps = () => React2.useContext(GoogleMapsContext);
-
-// src/useGeocoder.ts
-var React3 = __toESM(require("react"));
-var useGeocoder = () => {
-  const { googleMaps } = useGoogleMaps();
-  const [isGeocoderInitialized, setIsGeocoderInitialized] = React3.useState(false);
-  const geocoder = React3.useMemo(() => {
-    if (googleMaps) {
-      const googleMapsGeocoder = new googleMaps.Geocoder();
-      setIsGeocoderInitialized(true);
-      return googleMapsGeocoder;
-    }
-    return null;
-  }, [googleMaps]);
-  return { geocoder, isGeocoderInitialized };
-};
-
-// src/useMap.ts
-var React4 = __toESM(require("react"));
-var import_use_callback_ref = require("use-callback-ref");
-var useMap = (options = {}) => {
-  const [, forceUpdate] = React4.useState(0);
-  const ref = (0, import_use_callback_ref.useCallbackRef)(null, () => forceUpdate((n) => n + 1));
-  const { googleMaps } = useGoogleMaps();
-  const map = React4.useMemo(() => {
-    if (googleMaps && ref.current) {
-      return new googleMaps.Map(ref.current, options);
-    }
-    return null;
-  }, [googleMaps, ref.current]);
-  const optionsStringify = JSON.stringify(options);
-  React4.useEffect(() => {
-    if (map) {
-      const parsedOptions = JSON.parse(optionsStringify);
-      map.setOptions(parsedOptions);
-    }
-  }, [optionsStringify, map]);
-  return {
-    map,
-    ref
-  };
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  GoogleMapsProvider,
-  useGeocoder,
-  useGoogleMaps,
-  useMap
-});