@adamlui/geolocate 1.0.0

package/README.md

@@ -0,0 +1,193 @@
+# <picture><source media="(prefers-color-scheme: dark)" srcset="https://github.com/adamlui/js-utils/blob/main/geolocate/media/images/icons/wire-globe/white/icon32.png"><img height=28 src="https://github.com/adamlui/js-utils/blob/main/geolocate/media/images/icons/wire-globe/black/icon32.png"></picture> geolocate
+
+### Fetch IP geolocation data from the CLI.
+
+<a href="https://github.com/adamlui/js-utils/releases/tag/geolocate-1.0.0"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.0.0-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+<a href="https://www.npmjs.com/package/@adamlui/geolocate?activeTab=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/%40adamlui%2Fgeolocate?style=for-the-badge&logo=ebox&logoColor=white&labelColor=464646&color=blue"></a>
+<a href="https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_js-utils:geolocate/src/geolocate.js"><img height=31 src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fsonarcloud.io%2Fapi%2Fmeasures%2Fcomponent%3Fcomponent%3Dadamlui_js-utils%3Ageolocate%2Fsrc%2Fgeolocate.js%26metricKeys%3Dvulnerabilities&query=%24.component.measures.0.value&style=for-the-badge&logo=sonarcloud&logoColor=white&labelColor=464646&label=Vulnerabilities&color=gold"></a>
+
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
+## ⚡ Installation
+
+As a **global utility**:
+
+```
+$ npm install -g @adamlui/geolocate
+```
+
+As a **dev dependency**, from your project root:
+
+```
+$ npm install -D @adamlui/geolocate
+```
+
+As a **runtime dependency**, from your project root:
+
+```
+$ npm install @adamlui/geolocate
+```
+
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
+## 💻 Command line usage
+
+The basic **global command** is:
+
+```
+$ geolocate
+```
+
+Sample output:
+
+<img src="https://github.com/adamlui/js-utils/blob/main/geolocate/media/images/screenshots/cli-geolocate-8.8.8.8.jpg">
+
+**💡 Note:** If no IPv4 address is passed, your own one will be used.
+
+### Command line options
+
+```
+Boolean options:
+ -q, --quiet                 Suppress all logging except errors.
+
+Info commands:
+ -h, --help                  Display help screen.
+ -v, --version               Show version number.
+```
+
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
+## 🔌 Importing the API
+
+You can also import **geolocate** into your app to use its API methods.
+
+### <img height=18 src="https://i.imgur.com/JIeAdsr.png"> Node.js
+
+#### ES module*:
+
+```js
+import * as geo from '@adamlui/geolocate';
+```
+
+#### CommonJS:
+
+```js
+const geo = require('@adamlui/geolocate');
+```
+
+###### _*Node.js version 14 or higher required_
+
+### <picture><source media="(prefers-color-scheme: dark)" srcset="https://i.imgur.com/JSEb19A.png"><img width=16 src="https://i.imgur.com/5VPxf9y.png"></picture> Web
+
+#### <> HTML script tag:
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@adamlui/geolocate@1.0.0/dist/generate-ip.min.js"></script>
+```
+
+#### ES6:
+
+```js
+(async () => {
+    await import('https://cdn.jsdelivr.net/npm/@adamlui/geolocate@1.0.0/dist/generate-ip.min.js');
+    // Your code here...
+})();
+```
+
+### <img height=17 src="https://raw.githubusercontent.com/KudoAI/chatgpt.js/main/starters/media/images/icons/tampermonkey-icon28.png"><img height=17.5 src="https://raw.githubusercontent.com/KudoAI/chatgpt.js/main/starters/media/images/icons/violentmonkey-icon100.png"> Greasemonkey
+
+```js
+...
+// @require https://cdn.jsdelivr.net/npm/@adamlui/geolocate@1.0.0/dist/geolocate.min.js
+// ==/UserScript==
+
+// Your code here...
+```
+
+<br>
+
+📝 **Note:** To always import the latest version (not recommended in production!) remove the `@1.0.0` version tag from the jsDelivr URL: `https://cdn.jsdelivr.net/npm/@adamlui/geolocate/dist/geolocate.min.js`
+
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
+## 📋 API usage
+
+### `locate([ip])`
+
+Asynchronous method to fetch geolocation data for the `ip` passed, returned as an object.
+
+**💡 Note:** If no `ip` is supplied, your own one will be used.
+
+```js
+// Using await syntax
+const location = await geo.locate('192.12.85.186');
+console.log(location);
+
+// Using .then() syntax
+geo.locate('192.12.85.186').then(location => {
+    console.log(location);
+});
+
+/* outputs:
+{
+  ip: '8.8.8.8',
+  country: 'United States',
+  countryCode: 'US',
+  region: 'VA',
+  regionName: 'Virginia',
+  city: 'Ashburn',
+  zip: '20149',
+  lat: 39.03,
+  lon: -77.5,
+  timezone: 'America/New_York',
+  isp: 'Google LLC'
+}
+*/
+```
+
+#
+
+### `getOwnIP()`
+
+Asynchronous method to fetch/return your own IP as a string:
+
+```js
+// Using await syntax
+const ip = await geo.getOwnIP();
+console.log(ip); // outputs your IP
+
+// Using .then() syntax
+geo.getOwnIP().then(ip => {
+    console.log(ip); // outputs your IP
+});
+```
+
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
+## 🏛️ MIT License
+
+**Copyright © 2023 [Adam Lui](https://github.com/adamlui)**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
+<a href="https://github.com/adamlui/js-utils">**JavaScript utilities**</a> /
+<a href="https://github.com/adamlui/js-utils/discussions">Discuss</a> /
+<a href="#-geolocate">Back to top ↑</a>

package/dist/cli.min.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+(async()=>{const e=require(__dirname.match(/src/)?"./geolocate":"./geolocate.min"),o=require("generate-ip")["ipv4"],s=require("child_process")["execSync"],r="",t={},n={flags:{quietMode:/^--?q(?:uiet)?(?:-?mode)?$/},infoCmds:{help:/^--?h(?:elp)?$/,version:/^--?ve?r?s?i?o?n?$/}};if(process.argv.forEach(o=>{var e,s;o.startsWith("-")&&(e=Object.keys(n.flags).find(e=>n.flags[e].test(o)),s=Object.keys(n.infoCmds).find(e=>n.infoCmds[e].test(o)),e?t[e]=!0:s||(console.error(`
+ERROR: Arg [${o}] not recognized.`),console.info(`
+${r}Valid arguments are below.`),f(["flags","infoCmds"]),process.exit(1)))}),process.argv.some(e=>n.infoCmds.help.test(e)))f();else if(process.argv.some(e=>n.infoCmds.version.test(e)))console.info("v"+require("./package.json").version);else{var i,a=process.argv.slice(2),l=[];for(let e=0;e<a.length;e++)a[e].startsWith("-")||(o.validate(a[e],{verbose:!1})?l.push(a[e]):(i=0==e?"st":1==e?"nd":"th",console.error(`ERROR: ${e+1+i} arg '${a[e]}' is not a valid IPv4 address.`),console.info("Type 'geolocate --help' for help."),process.exit(1)));0==l.length&&l.push(await e.getOwnIP()),l.forEach(e=>g(`Fetching geolocation data for ${e}...`));var c=[];for(const h of l)c.push(await e.locate(h));1==c.length&&g(c[0]),g("Copying to clipboard..."),p=(p=JSON.stringify(c)).replace(/\s+$/,"").replace(/"/g,'""'),"darwin"===process.platform?s(`printf "${p}" | pbcopy`):"linux"===process.platform?s(`printf "${p}" | xclip -selection clipboard`):"win32"===process.platform&&s(`Set-Clipboard -Value "${p}"`,{shell:"powershell"})}var p;function f(e=["cmdFormat","flags","infoCmds"]){const o={cmdFormat:[`
+${r}geolocate [ip] [options|commands]`],flags:["\nBoolean options:"," -q, --quiet                 Suppress all logging except errors."],infoCmds:["\nInfo commands:"," -h, --help                  Display help screen."," -v, --version               Show version number."]};e.forEach(e=>{o[e]?.forEach(e=>{{const r=process.stdout.columns||80,t=[],o=e.match(/\S+|\s+/g);let s="";o.forEach(e=>{var o=r-(0===t.length?0:29);s.length+e.length>o&&(t.push(0===t.length?s:s.trimStart()),s=""),s+=e}),t.push(0===t.length?s:s.trimStart()),t.forEach((e,o)=>console.info(0===o?e:" ".repeat(29)+e))}})})}function g(e){t.quietMode||console.info(e)}})();

package/dist/geolocate.min.js

@@ -0,0 +1 @@
+async function e(t){let r;try{r=require("generate-ip").ipv4.validate}catch(e){await import("https://cdn.jsdelivr.net/npm/generate-ip/dist/generate-ip.min.js"),r=ipv4.validate}if(r&&!r(t,{verbose:!1}))return console.error("geolocate() » ERROR: Invalid IP address passed.");try{let e;if("undefined"!=typeof fetch)e=await fetch("http://ip-api.com/json/"+t);else{if("function"!=typeof require)return console.error("geolocate() » ERROR: Environment not supported.");e=await require("axios").get("http://ip-api.com/json/"+t)}const{status:o,org:i,as:n,query:c,...a}=await e.json();return{ip:t,...a}}catch(e){console.error("geolocate() »",e)}}async function t(){return fetch("https://ifconfig.me/ip").then(e=>e.text()).catch(()=>fetch("http://ip-api.com/json/").then(e=>e.json()).then(e=>e.query)).catch(async()=>{try{var e=require("child_process")["exec"],t=require("util")["promisify"],{stdout:r,stderr:o}=await t(e)("curl -s ifconfig.me");return o?console.error("getOwnIP() »",o):r.trim()}catch(e){console.error("getOwnIP() »",e)}})}const r={geolocate:e,locate:e,getOwnIP:t};try{module.exports={...r}}catch(e){}try{window.geo={...r}}catch(e){}

package/docs/LICENSE.md

@@ -0,0 +1,9 @@
+# 🏛️ MIT License
+
+**Copyright © 2024 [Adam Lui](https://github.com/adamlui)**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/docs/SECURITY.md

@@ -0,0 +1,5 @@
+# 🛡️ Security Policy
+
+If you find a vulnerability, please open a [draft security advisory](https://github.com/adamlui/js-utils/security/advisories/new).
+
+Pull requests are also welcome, but for safety reasons, send an email to <adam@kudoai.com> and wait for a response before making it public.

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@adamlui/geolocate",
+  "version": "1.0.0",
+  "description": "Fetch IP geolocation data from the CLI.",
+  "author": {
+    "name": "Adam Lui",
+    "email": "adam@kudoai.com",
+    "url": "https://github.com/adamlui"
+  },
+  "homepage": "https://js-utils.com/geolocate",
+  "license": "MIT",
+  "main": "dist/geolocate.min.js",
+  "files": [
+    "dist",
+    "docs/"
+  ],
+  "bin": {
+    "geolocate": "dist/cli.min.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "minify-js src dist"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adamlui/js-utils.git"
+  },
+  "keywords": [
+    "geolocate",
+    "geolocation",
+    "ip",
+    "networking"
+  ],
+  "bugs": {
+    "url": "https://github.com/adamlui/js-utils/issues"
+  },
+  "dependencies": {
+    "generate-ip": "^2.2.0"
+  },
+  "devDependencies": {
+    "@adamlui/minify.js": "^1.4.10"
+  }
+}