@ip2geo/sdk 0.0.1

package/README.md

@@ -0,0 +1,98 @@
+<div align='center'>
+   <a href='https://axios-http.com'>
+        <img 
+            src='https://cdn-prod.ip2geo.dev/assets/npm/generals/ip2geo.svg' 
+            alt='Ip2Geo Logo' 
+        />
+   </a>
+
+   <br />
+</div>
+
+<p align='center'>
+    Your go-to IP-to-Geo cloud service — fast, accurate, and built for developers. Start free with 2,000 monthly requests. 
+</p>
+
+<p align='center'>
+    <a href='https://ip2geo.dev'>
+        <b>
+            Website
+        </b>
+    </a> 
+    •
+    <a href='https://app.ip2geo.dev'>
+        <b>
+            App
+        </b>
+    </a> 
+    •
+    <a href='https://docs.ip2geo.dev'>
+        <b>
+            Documentation
+        </b>
+    </a>
+</p>
+
+<br />
+
+## Intro to the Npm Package
+
+This package provides a lightweight, type-safe way to integrate Ip2Geo. Blazingly fast and works with Node, Bun, and Deno out of the box.
+
+### Installing
+```bun
+npm i @ip2geo/sdk@latest
+```
+
+### Initializing
+```typescript
+import { Init } from '@ip2geo/sdk'
+import { Env } from '@/data'
+
+await Init(Env.IP2GEO_API_KEY)
+```
+
+### Using
+```typescript
+import { ConvertIP, ConvertIPs } from '@ip2geo/sdk'
+
+const convertedIp = await ConvertIP({
+    ip: '8.8.8.8'
+})
+
+const convertedIps = await ConvertIPs({
+    ips: [
+        '8.8.8.8',
+        '1.1.1.1',
+        '9.9.9.9',
+        '64.6.64.6'
+    ]
+})
+
+// {
+//     success: boolean
+//     code: number
+//     message: string
+//     data: Ip | null
+//     _req: {
+//          reqId: string | null
+//          resTime: number
+//     }
+// }
+
+// {
+//     message: string
+//     code: number
+//     sucess: boolean
+//     data: [
+//         {
+//             ip: string
+//             conversion: Ip | null
+//         }
+//     ],
+//     _req: {
+//          reqId: string | null
+//          resTime: number
+//     }
+// }
+```

package/cjs/data/Constants.js

@@ -0,0 +1,33 @@
+'use strict';
+
+const API_ENDPOINT = 'https://api.ip2geo.dev';
+const DOCS_URL = 'https://docs.ip2geo.dev';
+const NPM_REGISTRY_URL = 'https://registry.npmjs.org/@ip2geo/sdk';
+const HTTP_METHODS = {
+    GET: 'get',
+    POST: 'post'};
+const HEADER_KEYS = {
+    X_API_KEY: 'X-Api-Key'
+};
+const FILE_TYPES = {
+    JSON: 'json'
+};
+const FILE_FORMATS = {
+    APPLICATION_JSON: `application/${FILE_TYPES.JSON}`
+};
+const HEADER_TYPES = {
+    CONTENT_TYPE: 'Content-Type'
+};
+const ENDPOINTS = {
+    CONVERT: '/convert'
+};
+
+exports.API_ENDPOINT = API_ENDPOINT;
+exports.DOCS_URL = DOCS_URL;
+exports.ENDPOINTS = ENDPOINTS;
+exports.FILE_FORMATS = FILE_FORMATS;
+exports.FILE_TYPES = FILE_TYPES;
+exports.HEADER_KEYS = HEADER_KEYS;
+exports.HEADER_TYPES = HEADER_TYPES;
+exports.HTTP_METHODS = HTTP_METHODS;
+exports.NPM_REGISTRY_URL = NPM_REGISTRY_URL;

package/cjs/data/Messages.js

@@ -0,0 +1,62 @@
+'use strict';
+
+var Constants = require('./Constants.js');
+var Console = require('../helpers/Console.js');
+var Translation = require('../helpers/Translation.js');
+
+/* eslint-disable no-control-regex */
+/* eslint-disable quotes */
+const MessageUpdate = (currentVersion, latestVersion) => {
+    const boxWidth = 70;
+    const topBorder = `┌${'─'.repeat(boxWidth - 2)}┐`;
+    const bottomBorder = `└${'─'.repeat(boxWidth - 2)}┘`;
+    const stripAnsi = (str) => str.replace(/\x1b\[[0-9;]*m/g, '');
+    const centerText = (text) => {
+        const visibleLength = stripAnsi(text).length;
+        const padding = Math.max(0, Math.floor((boxWidth - 2 - visibleLength) / 2));
+        const rightPadding = Math.max(0, boxWidth - 2 - padding - visibleLength);
+        return `│${' '.repeat(padding)}${text}${' '.repeat(rightPadding)}│`;
+    };
+    const updateText = `\x1b[1m\x1b[33m${Translation.default('console.update-available')}\x1b[0m \x1b[2m${currentVersion} → ${latestVersion}\x1b[0m`;
+    const changelogText = `${Translation.default('console.changelogs')} \x1b[36m${Constants.DOCS_URL}/sdk/changelogs\x1b[0m`;
+    const commandText = `${Translation.default('console.run')} \x1b[32m\`npm i @ip2geo/sdk@latest\`\x1b[0m ${Translation.default('console.to-update')}.`;
+    const disableText = `${Translation.default('console.disable-warning-using')}: \x1b[36m{ versionUpdateMessage: false }\x1b[0m ${Translation.default('console.on-init')}.`;
+    Console.default.Info('MessageUpdate', '', true);
+    Console.default.Info('MessageUpdate', topBorder, true);
+    Console.default.Info('MessageUpdate', centerText(updateText), true);
+    Console.default.Info('MessageUpdate', centerText(changelogText), true);
+    Console.default.Info('MessageUpdate', centerText(commandText), true);
+    Console.default.Info('MessageUpdate', centerText(''), true);
+    Console.default.Info('MessageUpdate', centerText(disableText), true);
+    Console.default.Info('MessageUpdate', bottomBorder, true);
+    Console.default.Info('MessageUpdate', '', true);
+};
+const MessageClientRuntime = () => {
+    const boxWidth = 70;
+    const topBorder = `┌${'─'.repeat(boxWidth - 2)}┐`;
+    const bottomBorder = `└${'─'.repeat(boxWidth - 2)}┘`;
+    const stripAnsi = (str) => str.replace(/\x1b\[[0-9;]*m/g, '');
+    const centerText = (text) => {
+        const visibleLength = stripAnsi(text).length;
+        const padding = Math.max(0, Math.floor((boxWidth - 2 - visibleLength) / 2));
+        const rightPadding = Math.max(0, boxWidth - 2 - padding - visibleLength);
+        return `│${' '.repeat(padding)}${text}${' '.repeat(rightPadding)}│`;
+    };
+    const titleText = `\x1b[1m\x1b[31m⚠ ${Translation.default('console.client-runtime-detected')}!\x1b[0m`;
+    const line1 = `${Translation.default('generals.ip2geo')} ${Translation.default('console.must-run-in')} ${Translation.default('console.a')} \x1b[32m${Translation.default('console.server-side-environment')}\x1b[0m ${Translation.default('console.only')}.`;
+    const line2 = Translation.default('console.client-side-usage-warning');
+    const disableText = `${Translation.default('console.disable-warning-using')}: \x1b[36m{ clientRuntimeMessage: false }\x1b[0m ${Translation.default('console.on-init')}.`;
+    Console.default.Info('MessageClientRuntime', '', true);
+    Console.default.Info('MessageClientRuntime', topBorder, true);
+    Console.default.Info('MessageClientRuntime', centerText(titleText), true);
+    Console.default.Info('MessageClientRuntime', centerText(''), true);
+    Console.default.Info('MessageClientRuntime', centerText(line1), true);
+    Console.default.Info('MessageClientRuntime', centerText(line2), true);
+    Console.default.Info('MessageClientRuntime', centerText(''), true);
+    Console.default.Info('MessageClientRuntime', centerText(disableText), true);
+    Console.default.Info('MessageClientRuntime', bottomBorder, true);
+    Console.default.Info('MessageClientRuntime', '', true);
+};
+
+exports.MessageClientRuntime = MessageClientRuntime;
+exports.MessageUpdate = MessageUpdate;

package/cjs/data/States.js

@@ -0,0 +1,10 @@
+'use strict';
+
+const STATE = {
+    AUTH_KEY: null,
+    CLIENT_RUNTIME_MESSAGE: true,
+    VERSION_UPDATE_MESSAGE: true,
+    IS_VERSION_CHECKED: false
+};
+
+exports.STATE = STATE;

package/cjs/helpers/CheckRuntime.js

@@ -0,0 +1,17 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Messages = require('../data/Messages.js');
+var States = require('../data/States.js');
+var IsBrowser = require('./IsBrowser.js');
+
+const CheckRuntime = () => {
+    if (States.STATE.CLIENT_RUNTIME_MESSAGE) {
+        const isBrowser = IsBrowser.default();
+        if (isBrowser)
+            Messages.MessageClientRuntime();
+    }
+};
+
+exports.default = CheckRuntime;

package/cjs/helpers/CheckVersion.js

@@ -0,0 +1,23 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var _package = require('../prebuild/package.json.js');
+var Messages = require('../data/Messages.js');
+var States = require('../data/States.js');
+var GetNpmVersion = require('./GetNpmVersion.js');
+
+const CheckVersion = async () => {
+    if (!States.STATE.IS_VERSION_CHECKED && States.STATE.VERSION_UPDATE_MESSAGE) {
+        States.STATE.IS_VERSION_CHECKED = true;
+        const currentVersion = _package.version;
+        const latestVersion = await GetNpmVersion.default();
+        if (typeof latestVersion === 'string') {
+            const isDifferent = currentVersion !== latestVersion;
+            if (isDifferent)
+                Messages.MessageUpdate(currentVersion, latestVersion);
+        }
+    }
+};
+
+exports.default = CheckVersion;

package/cjs/helpers/Console.js

@@ -0,0 +1,26 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const Console = {
+    Error: (func, message, ignoreFunName = false) => {
+        if (ignoreFunName)
+            console.error(message);
+        else
+            console.error(func, message);
+    },
+    Info: (func, message, ignoreFunName = false) => {
+        if (ignoreFunName)
+            console.info(message);
+        else
+            console.info(func, message);
+    },
+    Warning: (func, message, ignoreFunName = false) => {
+        if (ignoreFunName)
+            console.warn(message);
+        else
+            console.warn(func, message);
+    }
+};
+
+exports.default = Console;

package/cjs/helpers/GetNpmVersion.js

@@ -0,0 +1,20 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Constants = require('../data/Constants.js');
+var Console = require('./Console.js');
+
+const GetNpmVersion = async () => {
+    try {
+        const response = await fetch(Constants.NPM_REGISTRY_URL);
+        const data = await response.json();
+        return data['dist-tags']?.latest;
+    }
+    catch (error) {
+        Console.default.Error('GetNpmVersion', error);
+        return null;
+    }
+};
+
+exports.default = GetNpmVersion;

package/cjs/helpers/Http.js

@@ -0,0 +1,50 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Constants = require('../data/Constants.js');
+var States = require('../data/States.js');
+var Console = require('./Console.js');
+var IsBrowser = require('./IsBrowser.js');
+
+const Http = async (endpoint, ipAddresses) => {
+    const options = {
+        method: Constants.HTTP_METHODS.GET,
+        headers: {
+            [Constants.HEADER_TYPES.CONTENT_TYPE]: Constants.FILE_FORMATS.APPLICATION_JSON,
+            [Constants.HEADER_KEYS.X_API_KEY]: States.STATE.AUTH_KEY
+        }
+    };
+    if (Array.isArray(ipAddresses) && ipAddresses?.length > 0) {
+        options['method'] = Constants.HTTP_METHODS.POST;
+        options['body'] = JSON.stringify({
+            ips: ipAddresses
+        });
+    }
+    const isBrowser = IsBrowser.default();
+    if (!isBrowser) {
+        try {
+            const fetchModule = await import('node-fetch');
+            const fetch = fetchModule.default;
+            const request = await fetch(endpoint, options);
+            return await request.json();
+        }
+        catch (error) {
+            Console.default.Error('Http', error);
+            return null;
+        }
+    }
+    else {
+        try {
+            const request = await fetch(endpoint, options);
+            const response = await request.json();
+            return response;
+        }
+        catch (error) {
+            Console.default.Error('Http', error);
+            return null;
+        }
+    }
+};
+
+exports.default = Http;

package/cjs/helpers/IpValidation.js

@@ -0,0 +1,31 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Console = require('./Console.js');
+
+const IpValidation = (ipAddress) => {
+    const isString = typeof ipAddress === 'string';
+    if (!isString)
+        return {
+            ip4: false,
+            ip6: false
+        };
+    try {
+        const ip4 = /^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/.test(ipAddress);
+        const ip6 = /^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$|^([0-9a-fA-F]{1,4}:){1,7}:$|^([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}$|^([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}$|^([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}$|^([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}$|^([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}$|^[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6}|:)$|^:((:[0-9a-fA-F]{1,4}){1,7}|:)$/.test(ipAddress);
+        return {
+            ip4,
+            ip6
+        };
+    }
+    catch (error) {
+        Console.default.Error('IpAddressValidation', error);
+        return {
+            ip4: false,
+            ip6: false
+        };
+    }
+};
+
+exports.default = IpValidation;

package/cjs/helpers/IsBrowser.js

@@ -0,0 +1,9 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const IsBrowser = () => {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+};
+
+exports.default = IsBrowser;

package/cjs/helpers/Translation.js

@@ -0,0 +1,21 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var en_US = require('../langs/en_US.js');
+
+const Translation = (translationKey) => {
+    const lang = en_US.default;
+    const keys = translationKey.split('.');
+    let result = lang;
+    for (const key of keys) {
+        if (result && typeof result === 'object' && result !== null && key in result) {
+            result = result[key];
+        }
+        else
+            return translationKey;
+    }
+    return typeof result === 'string' ? result : translationKey;
+};
+
+exports.default = Translation;

package/cjs/index.js

@@ -0,0 +1,18 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var ConvertIP = require('./methods/ConvertIP.js');
+var ConvertIPs = require('./methods/ConvertIPs.js');
+var Init = require('./methods/Init.js');
+
+const Ip2Geo = {
+    ConvertIPs: ConvertIPs.default,
+    ConvertIP: ConvertIP.default,
+    Init: Init.default
+};
+
+exports.ConvertIP = ConvertIP.default;
+exports.ConvertIPs = ConvertIPs.default;
+exports.Init = Init.default;
+exports.default = Ip2Geo;

package/cjs/langs/en_US.js

@@ -0,0 +1,32 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const en_US = {
+    'generals': {
+        'ip2geo': 'Ip2Geo'
+    },
+    'console': {
+        'update-available': 'Update available!',
+        'changelogs': 'Changelogs:',
+        'run': 'Run',
+        'to-update': 'to update',
+        'disable-warning-using': 'Disable warning using',
+        'on-init': 'on init',
+        'client-runtime-detected': 'Client Runtime Detected',
+        'client-side-usage-warning': 'Client-side usage exposes your API key publicly.',
+        'only': 'only',
+        'server-side-environment': 'Server-side environment',
+        'must-run-in': 'must run in',
+        'a': 'a'
+    },
+    'conversions': {
+        'ip-address-is-required-to-convert-it': 'IP address is required to convert it.',
+        'ip-addresses-are-required-to-convert-them': 'IP addresses are required to convert them.',
+        'invalid-ip-address-so-we-could-not-convert-it': 'Invalid IP address so we could not convert it.',
+        'all-ip-addresses-are-invalid': 'All IP addresses are invalid.',
+        'some-ip-addresses-are-invalid': 'Some IP addresses are invalid.'
+    }
+};
+
+exports.default = en_US;

package/cjs/methods/ConvertIP.js

@@ -0,0 +1,50 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Constants = require('../data/Constants.js');
+var Console = require('../helpers/Console.js');
+var Http = require('../helpers/Http.js');
+var IpValidation = require('../helpers/IpValidation.js');
+var Translation = require('../helpers/Translation.js');
+
+const ConvertIP = async (options) => {
+    const { ip } = options || {};
+    if (!ip)
+        return {
+            success: false,
+            message: Translation.default('conversions.ip-address-is-required-to-convert-it'),
+            code: 400,
+            data: null,
+            _req: {
+                reqId: null,
+                resTime: 0
+            }
+        };
+    const { ip4, ip6 } = IpValidation.default(ip);
+    if (!ip4 && !ip6)
+        return {
+            success: false,
+            message: Translation.default('conversions.invalid-ip-address-so-we-could-not-convert-it'),
+            code: 400,
+            data: null,
+            _req: {
+                reqId: null,
+                resTime: 0
+            }
+        };
+    try {
+        const ipLink = `${Constants.API_ENDPOINT}${Constants.ENDPOINTS.CONVERT}?ip=${ip}`;
+        const ipResponse = await Http.default(ipLink);
+        if (ipResponse)
+            return ipResponse;
+        else
+            return null;
+    }
+    catch (error) {
+        Console.default.Error('ConvertIP', error);
+        return null;
+    }
+};
+
+exports.default = ConvertIP;

package/cjs/methods/ConvertIPs.js

@@ -0,0 +1,59 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var Constants = require('../data/Constants.js');
+var Console = require('../helpers/Console.js');
+var Http = require('../helpers/Http.js');
+var IpValidation = require('../helpers/IpValidation.js');
+var Translation = require('../helpers/Translation.js');
+
+const ConvertIPs = async (props) => {
+    const { ips } = props;
+    if (!ips || !Array.isArray(ips) || ips.length === 0)
+        return {
+            success: false,
+            message: Translation.default('conversions.ip-addresses-are-required-to-convert-them'),
+            code: 400,
+            data: null,
+            _req: {
+                reqId: null,
+                resTime: 0
+            }
+        };
+    const invalidIps = [];
+    for (const ip of ips) {
+        const { ip4, ip6 } = IpValidation.default(ip);
+        if (!ip4 && !ip6)
+            invalidIps.push(ip);
+    }
+    const isAllInvalid = invalidIps?.length === ips?.length;
+    if (invalidIps?.length > 0)
+        return {
+            success: false,
+            message: isAllInvalid ? Translation.default('conversions.all-ip-addresses-are-invalid') : Translation.default('conversions.some-ip-addresses-are-invalid'),
+            code: 400,
+            data: invalidIps?.map(ip => ({
+                ip,
+                conversion: null
+            })),
+            _req: {
+                reqId: null,
+                resTime: 0
+            }
+        };
+    try {
+        const ipLink = `${Constants.API_ENDPOINT}${Constants.ENDPOINTS.CONVERT}`;
+        const ipResponse = await Http.default(ipLink, ips);
+        if (ipResponse)
+            return ipResponse;
+        else
+            return null;
+    }
+    catch (error) {
+        Console.default.Error('ConvertIPs', error);
+        return null;
+    }
+};
+
+exports.default = ConvertIPs;

package/cjs/methods/Init.js

@@ -0,0 +1,32 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var CheckVersion = require('../helpers/CheckVersion.js');
+var CheckRuntime = require('../helpers/CheckRuntime.js');
+var Console = require('../helpers/Console.js');
+var States = require('../data/States.js');
+
+const Init = async (key, options) => {
+    try {
+        const crm = options?.clientRuntimeMessage;
+        const vum = options?.versionUpdateMessage;
+        States.STATE.AUTH_KEY = key;
+        States.STATE.CLIENT_RUNTIME_MESSAGE = typeof crm === 'boolean' ? crm : true;
+        States.STATE.VERSION_UPDATE_MESSAGE = typeof vum === 'boolean' ? vum : true;
+        return Promise.resolve(true);
+    }
+    catch (error) {
+        States.STATE.AUTH_KEY = null;
+        States.STATE.CLIENT_RUNTIME_MESSAGE = true;
+        States.STATE.VERSION_UPDATE_MESSAGE = true;
+        Console.default.Error('Init', error);
+        return Promise.resolve(false);
+    }
+    finally {
+        CheckRuntime.default();
+        CheckVersion.default();
+    }
+};
+
+exports.default = Init;

package/cjs/prebuild/package.json.js

@@ -0,0 +1,5 @@
+'use strict';
+
+var version = "0.0.1";
+
+exports.version = version;

package/esm/data/Constants.js

@@ -0,0 +1,23 @@
+const API_ENDPOINT = 'https://api.ip2geo.dev';
+const DOCS_URL = 'https://docs.ip2geo.dev';
+const NPM_REGISTRY_URL = 'https://registry.npmjs.org/@ip2geo/sdk';
+const HTTP_METHODS = {
+    GET: 'get',
+    POST: 'post'};
+const HEADER_KEYS = {
+    X_API_KEY: 'X-Api-Key'
+};
+const FILE_TYPES = {
+    JSON: 'json'
+};
+const FILE_FORMATS = {
+    APPLICATION_JSON: `application/${FILE_TYPES.JSON}`
+};
+const HEADER_TYPES = {
+    CONTENT_TYPE: 'Content-Type'
+};
+const ENDPOINTS = {
+    CONVERT: '/convert'
+};
+
+export { API_ENDPOINT, DOCS_URL, ENDPOINTS, FILE_FORMATS, FILE_TYPES, HEADER_KEYS, HEADER_TYPES, HTTP_METHODS, NPM_REGISTRY_URL };