@ip2geo/sdk 0.0.1

package/esm/data/Messages.js

@@ -0,0 +1,59 @@
+import { DOCS_URL } from './Constants.js';
+import Console from '../helpers/Console.js';
+import Translation from '../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('console.update-available')}\x1b[0m \x1b[2m${currentVersion} → ${latestVersion}\x1b[0m`;
+    const changelogText = `${Translation('console.changelogs')} \x1b[36m${DOCS_URL}/sdk/changelogs\x1b[0m`;
+    const commandText = `${Translation('console.run')} \x1b[32m\`npm i @ip2geo/sdk@latest\`\x1b[0m ${Translation('console.to-update')}.`;
+    const disableText = `${Translation('console.disable-warning-using')}: \x1b[36m{ versionUpdateMessage: false }\x1b[0m ${Translation('console.on-init')}.`;
+    Console.Info('MessageUpdate', '', true);
+    Console.Info('MessageUpdate', topBorder, true);
+    Console.Info('MessageUpdate', centerText(updateText), true);
+    Console.Info('MessageUpdate', centerText(changelogText), true);
+    Console.Info('MessageUpdate', centerText(commandText), true);
+    Console.Info('MessageUpdate', centerText(''), true);
+    Console.Info('MessageUpdate', centerText(disableText), true);
+    Console.Info('MessageUpdate', bottomBorder, true);
+    Console.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('console.client-runtime-detected')}!\x1b[0m`;
+    const line1 = `${Translation('generals.ip2geo')} ${Translation('console.must-run-in')} ${Translation('console.a')} \x1b[32m${Translation('console.server-side-environment')}\x1b[0m ${Translation('console.only')}.`;
+    const line2 = Translation('console.client-side-usage-warning');
+    const disableText = `${Translation('console.disable-warning-using')}: \x1b[36m{ clientRuntimeMessage: false }\x1b[0m ${Translation('console.on-init')}.`;
+    Console.Info('MessageClientRuntime', '', true);
+    Console.Info('MessageClientRuntime', topBorder, true);
+    Console.Info('MessageClientRuntime', centerText(titleText), true);
+    Console.Info('MessageClientRuntime', centerText(''), true);
+    Console.Info('MessageClientRuntime', centerText(line1), true);
+    Console.Info('MessageClientRuntime', centerText(line2), true);
+    Console.Info('MessageClientRuntime', centerText(''), true);
+    Console.Info('MessageClientRuntime', centerText(disableText), true);
+    Console.Info('MessageClientRuntime', bottomBorder, true);
+    Console.Info('MessageClientRuntime', '', true);
+};
+
+export { MessageClientRuntime, MessageUpdate };

package/esm/data/States.js

@@ -0,0 +1,8 @@
+const STATE = {
+    AUTH_KEY: null,
+    CLIENT_RUNTIME_MESSAGE: true,
+    VERSION_UPDATE_MESSAGE: true,
+    IS_VERSION_CHECKED: false
+};
+
+export { STATE };

package/esm/helpers/CheckRuntime.js

@@ -0,0 +1,13 @@
+import { MessageClientRuntime } from '../data/Messages.js';
+import { STATE } from '../data/States.js';
+import IsBrowser from './IsBrowser.js';
+
+const CheckRuntime = () => {
+    if (STATE.CLIENT_RUNTIME_MESSAGE) {
+        const isBrowser = IsBrowser();
+        if (isBrowser)
+            MessageClientRuntime();
+    }
+};
+
+export { CheckRuntime as default };

package/esm/helpers/CheckVersion.js

@@ -0,0 +1,19 @@
+import { version } from '../prebuild/package.json.js';
+import { MessageUpdate } from '../data/Messages.js';
+import { STATE } from '../data/States.js';
+import GetNpmVersion from './GetNpmVersion.js';
+
+const CheckVersion = async () => {
+    if (!STATE.IS_VERSION_CHECKED && STATE.VERSION_UPDATE_MESSAGE) {
+        STATE.IS_VERSION_CHECKED = true;
+        const currentVersion = version;
+        const latestVersion = await GetNpmVersion();
+        if (typeof latestVersion === 'string') {
+            const isDifferent = currentVersion !== latestVersion;
+            if (isDifferent)
+                MessageUpdate(currentVersion, latestVersion);
+        }
+    }
+};
+
+export { CheckVersion as default };

package/esm/helpers/Console.js

@@ -0,0 +1,22 @@
+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);
+    }
+};
+
+export { Console as default };

package/esm/helpers/GetNpmVersion.js

@@ -0,0 +1,16 @@
+import { NPM_REGISTRY_URL } from '../data/Constants.js';
+import Console from './Console.js';
+
+const GetNpmVersion = async () => {
+    try {
+        const response = await fetch(NPM_REGISTRY_URL);
+        const data = await response.json();
+        return data['dist-tags']?.latest;
+    }
+    catch (error) {
+        Console.Error('GetNpmVersion', error);
+        return null;
+    }
+};
+
+export { GetNpmVersion as default };

package/esm/helpers/Http.js

@@ -0,0 +1,46 @@
+import { FILE_FORMATS, HTTP_METHODS, HEADER_KEYS, HEADER_TYPES } from '../data/Constants.js';
+import { STATE } from '../data/States.js';
+import Console from './Console.js';
+import IsBrowser from './IsBrowser.js';
+
+const Http = async (endpoint, ipAddresses) => {
+    const options = {
+        method: HTTP_METHODS.GET,
+        headers: {
+            [HEADER_TYPES.CONTENT_TYPE]: FILE_FORMATS.APPLICATION_JSON,
+            [HEADER_KEYS.X_API_KEY]: STATE.AUTH_KEY
+        }
+    };
+    if (Array.isArray(ipAddresses) && ipAddresses?.length > 0) {
+        options['method'] = HTTP_METHODS.POST;
+        options['body'] = JSON.stringify({
+            ips: ipAddresses
+        });
+    }
+    const isBrowser = IsBrowser();
+    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.Error('Http', error);
+            return null;
+        }
+    }
+    else {
+        try {
+            const request = await fetch(endpoint, options);
+            const response = await request.json();
+            return response;
+        }
+        catch (error) {
+            Console.Error('Http', error);
+            return null;
+        }
+    }
+};
+
+export { Http as default };

package/esm/helpers/IpValidation.js

@@ -0,0 +1,27 @@
+import Console from './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.Error('IpAddressValidation', error);
+        return {
+            ip4: false,
+            ip6: false
+        };
+    }
+};
+
+export { IpValidation as default };

package/esm/helpers/IsBrowser.js

@@ -0,0 +1,5 @@
+const IsBrowser = () => {
+    return typeof window !== 'undefined' && typeof window.document !== 'undefined';
+};
+
+export { IsBrowser as default };

package/esm/helpers/Translation.js

@@ -0,0 +1,17 @@
+import en_US from '../langs/en_US.js';
+
+const Translation = (translationKey) => {
+    const lang = en_US;
+    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;
+};
+
+export { Translation as default };

package/esm/index.js

@@ -0,0 +1,11 @@
+import ConvertIP from './methods/ConvertIP.js';
+import ConvertIPs from './methods/ConvertIPs.js';
+import Init from './methods/Init.js';
+
+const Ip2Geo = {
+    ConvertIPs,
+    ConvertIP,
+    Init
+};
+
+export { ConvertIP, ConvertIPs, Init, Ip2Geo as default };

package/esm/langs/en_US.js

@@ -0,0 +1,28 @@
+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.'
+    }
+};
+
+export { en_US as default };

package/esm/methods/ConvertIP.js

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

package/esm/methods/ConvertIPs.js

@@ -0,0 +1,55 @@
+import { API_ENDPOINT, ENDPOINTS } from '../data/Constants.js';
+import Console from '../helpers/Console.js';
+import Http from '../helpers/Http.js';
+import IpValidation from '../helpers/IpValidation.js';
+import Translation from '../helpers/Translation.js';
+
+const ConvertIPs = async (props) => {
+    const { ips } = props;
+    if (!ips || !Array.isArray(ips) || ips.length === 0)
+        return {
+            success: false,
+            message: Translation('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(ip);
+        if (!ip4 && !ip6)
+            invalidIps.push(ip);
+    }
+    const isAllInvalid = invalidIps?.length === ips?.length;
+    if (invalidIps?.length > 0)
+        return {
+            success: false,
+            message: isAllInvalid ? Translation('conversions.all-ip-addresses-are-invalid') : Translation('conversions.some-ip-addresses-are-invalid'),
+            code: 400,
+            data: invalidIps?.map(ip => ({
+                ip,
+                conversion: null
+            })),
+            _req: {
+                reqId: null,
+                resTime: 0
+            }
+        };
+    try {
+        const ipLink = `${API_ENDPOINT}${ENDPOINTS.CONVERT}`;
+        const ipResponse = await Http(ipLink, ips);
+        if (ipResponse)
+            return ipResponse;
+        else
+            return null;
+    }
+    catch (error) {
+        Console.Error('ConvertIPs', error);
+        return null;
+    }
+};
+
+export { ConvertIPs as default };

package/esm/methods/Init.js

@@ -0,0 +1,28 @@
+import CheckVersion from '../helpers/CheckVersion.js';
+import CheckRuntime from '../helpers/CheckRuntime.js';
+import Console from '../helpers/Console.js';
+import { STATE } from '../data/States.js';
+
+const Init = async (key, options) => {
+    try {
+        const crm = options?.clientRuntimeMessage;
+        const vum = options?.versionUpdateMessage;
+        STATE.AUTH_KEY = key;
+        STATE.CLIENT_RUNTIME_MESSAGE = typeof crm === 'boolean' ? crm : true;
+        STATE.VERSION_UPDATE_MESSAGE = typeof vum === 'boolean' ? vum : true;
+        return Promise.resolve(true);
+    }
+    catch (error) {
+        STATE.AUTH_KEY = null;
+        STATE.CLIENT_RUNTIME_MESSAGE = true;
+        STATE.VERSION_UPDATE_MESSAGE = true;
+        Console.Error('Init', error);
+        return Promise.resolve(false);
+    }
+    finally {
+        CheckRuntime();
+        CheckVersion();
+    }
+};
+
+export { Init as default };

package/esm/prebuild/package.json.js

@@ -0,0 +1,3 @@
+var version = "0.0.1";
+
+export { version };