merge: develop into main

.all-contributorsrc

@@ -31,6 +31,15 @@
       "contributions": [
         "features"
       ]
+    },
+    {
+      "login": "Glerme",
+      "name": "Guilherme Felipe",
+      "avatar_url": "https://avatars.githubusercontent.com/u/62507710?v=4",
+      "profile": "https://github.com/Glerme",
+      "contributions": [
+        "features"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -76,13 +76,19 @@ These are just some of the ways you can contribute to the project read the [CONT
 <table>
   <tr>
     <td align="center"><a href="https://wesleyaraujo.dev/"><img src="https://avatars.githubusercontent.com/u/89321125?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Wesley Araújo</b></sub></a><br /></td>
-    <td align="center"><a href="https://github.com/Patryck-Silva"><img src="https://avatars.githubusercontent.com/u/41785386?v=4" width="100px;" alt=""/><br /><sub><b>Patryck Silva</b></sub></a><br /></td>
-    <td align="center"><a href="https://github.com/joaoianuci"><img src="https://avatars.githubusercontent.com/u/42063789?v=4" width="100px;" alt=""/><br /><sub><b>João Vitor Ianuci</b></sub></a><br /></td>
   </tr>
 </table>
 
 ## ✨ Contributors
 
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/Patryck-Silva"><img src="https://avatars.githubusercontent.com/u/41785386?v=4" width="100px;" alt=""/><br /><sub><b>Patryck Silva</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/joaoianuci"><img src="https://avatars.githubusercontent.com/u/42063789?v=4" width="100px;" alt=""/><br /><sub><b>João Vitor Ianuci</b></sub></a><br /></td>
+    <td align="center"><a href="https://github.com/Glerme"><img src="https://avatars.githubusercontent.com/u/62507710?v=4" width="100px;" alt=""/><br /><sub><b>Guilherme Felipe</b></sub></a><br /></td>
+  </tr>
+</table>
+
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->

docs/react.md

@@ -64,3 +64,18 @@ import { useNow } from "utils-react";
 const now = useNow();
 console.log(now);
 ```
+
+## useToggle
+
+Toggle a boolean.
+
+```js
+import { useToggle } from "utils-react";
+
+// called in a component
+const { toggleValue, handleToggleValue } = useToggle();
+
+console.log(toggleValue); // false
+handleToggleValue();
+console.log(toggleValue); // true
+```

docs/vanilla.md

@@ -279,3 +279,13 @@ import { removeStorage } from "utils-react";
 
 removeStorage("name");
 ```
+
+## getNavigatorCurrentLocation
+
+Get the current location of the navigator.
+
+```js
+import { getNavigatorCurrentLocation } from "utils-react";
+
+getNavigatorCurrentLocation().then((location) => console.log(location));
+```

package.json

@@ -44,12 +44,14 @@
   "homepage": "https://github.com/wesleyara/utils-react#readme",
   "dependencies": {
     "axios": "^1.2.0",
+    "jsdom": "^22.1.0",
     "react": "^18.2.0",
     "rimraf": "^3.0.2"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.3.0",
     "@commitlint/config-conventional": "^17.1.0",
+    "@types/jsdom": "^21.1.2",
     "@types/node": "^18.11.9",
     "@types/react": "^18.0.25",
     "@typescript-eslint/eslint-plugin": "^5.45.0",

src/@types/index.ts

@@ -0,0 +1,4 @@
+export interface IGetNavigatorCurrentLocation {
+  successCallback: PositionCallback;
+  errorCallback: PositionErrorCallback;
+}

src/__test__/index.test.ts

@@ -1,4 +1,8 @@
-import { describe, expect, it } from "vitest";
+/**
+ * @jest-environment jsdom
+ */
+
+import { describe, expect, it, vitest } from "vitest";
 
 import {
   upperFirst,
@@ -19,6 +23,7 @@ import {
   generateNullArray,
   generateRandomString,
   generateRandomColor,
+  getNavigatorCurrentLocation,
 } from "../index";
 
 describe("all methods in the package", () => {
@@ -122,4 +127,46 @@ describe("all methods in the package", () => {
   it("generate a random color", () => {
     expect(generateRandomColor()).toBeTypeOf("string");
   });
+
+  it("get current location", async () => {
+    const mockSuccessCallback = vitest.fn();
+    const mockErrorCallback = vitest.fn();
+
+    if (!global.navigator.geolocation) {
+      return;
+    }
+
+    global.navigator.geolocation.getCurrentPosition = vitest.fn(success => {
+      success({
+        coords: {
+          latitude: 10,
+          longitude: 20,
+          accuracy: 1,
+          altitude: null,
+          altitudeAccuracy: null,
+          heading: null,
+          speed: null,
+        },
+        timestamp: 123,
+      });
+    });
+
+    const result = await getNavigatorCurrentLocation({
+      successCallback: mockSuccessCallback,
+      errorCallback: mockErrorCallback,
+    });
+
+    expect(result).toEqual({
+      coords: {
+        latitude: 10,
+        longitude: 20,
+        accuracy: 1,
+        altitude: null,
+        altitudeAccuracy: null,
+        heading: null,
+        speed: null,
+      },
+      timestamp: 123,
+    });
+  });
 });

src/modules/index.ts

@@ -1,5 +1,7 @@
 import axios from "axios";
 
+import { IGetNavigatorCurrentLocation } from "../@types";
+
 export const upperFirst = (str: string) => {
   return str.charAt(0).toUpperCase() + str.slice(1);
 };
@@ -31,7 +33,7 @@
   return str.split("").reverse().join("");
 };
 
 export const arrayEquals = (a: any[], b: any[]) => {
   if (!Array.isArray(a) || !Array.isArray(b) || a.length !== b.length) {
     return false;
   }
@@ -45,14 +47,14 @@
   return true;
 };
 
 export const arrayToObject = (array: any[], key: string) => {
   return array.reduce((obj, item) => {
     obj[item[key]] = item;
     return obj;
   }, {});
 };
 
 export const removeArrayItemByValue = (array: any[], value: any) => {
   const index = array.indexOf(value);
   if (index > -1) {
     array.splice(index, 1);
@@ -61,7 +63,7 @@
   return array;
 };
 
 export const removeArrayItemByIndex = (array: any[], index: number) => {
   if (index > -1) {
     array.splice(index, 1);
   }
@@ -69,7 +71,7 @@
   return array;
 };
 
 export const objectToArray = (obj: any) => {
   return Object.keys(obj).map(key => obj[key]);
 };
 
@@ -98,7 +100,7 @@
 };
 
 export const smartLog = (
   value: any,
   currentFunction: Function,
   label?: string,
 ) => {
@@ -110,11 +112,11 @@
   );
 };
 
 export function isEmptyObject(obj: any) {
   return JSON.stringify(obj) === "{}";
 }
 
 export const shuffleArray = (array: any) => {
   for (let i = array.length - 1; i > 0; i--) {
     const j = Math.floor(Math.random() * (i + 1));
     const temp = array[i];
@@ -182,3 +184,14 @@
 export const generateRandomColor = () => {
   return "#" + Math.floor(Math.random() * 16777215).toString(16);
 };
+
+export const getNavigatorCurrentLocation = async ({
+  successCallback,
+  errorCallback,
+}: IGetNavigatorCurrentLocation) => {
+  const { coords, timestamp }: GeolocationPosition = await new Promise(() => {
+    navigator.geolocation.getCurrentPosition(successCallback, errorCallback);
+  });
+
+  return { coords, timestamp };
+};

src/modules/react/index.ts

@@ -71,3 +71,21 @@ export const useNow = () => {
 
   return now;
 };
+
+export const useToggle = (
+  initialValue: boolean,
+): {
+  toggleValue: boolean;
+  handleToggleValue: () => void;
+} => {
+  const [toggleValue, setToggleValue] = useState(initialValue);
+
+  const handleToggleValue = () => {
+    setToggleValue(state => !state);
+  };
+
+  return {
+    toggleValue,
+    handleToggleValue,
+  };
+};