@ip2geo/sdk 0.0.1

package/index.d.ts

@@ -0,0 +1,304 @@
+declare const IP_TYPES: {
+    IPV4: string;
+    IPV6: string;
+};
+
+type IpTypes = (typeof IP_TYPES)[keyof typeof IP_TYPES];
+type Expand<T> = T extends infer O ? O extends object ? O extends Array<infer U> ? Array<Expand<U>> : O extends Function ? O : {
+    [K in keyof O]: Expand<O[K]>;
+} : O : never;
+interface Ip {
+    ip: string | null;
+    type: IpTypes | null;
+    is_eu: boolean | null;
+    continent: {
+        name: string | null;
+        code: string | null;
+        country: {
+            name: string | null;
+            code: string | null;
+            phone_code: string | null;
+            capital: string | null;
+            tld: string | null;
+            city: {
+                name: string | null;
+                latitude: number | null;
+                longitude: number | null;
+                postal_code: string | null;
+                timezone: {
+                    name: string | null;
+                    time_now: string | null;
+                };
+            };
+            flag: {
+                img: string | null;
+                emoji: string | null;
+                emoji_unicode: string | null;
+            };
+            currency: {
+                name: string | null;
+                code: string | null;
+                symbol: string | null;
+            };
+        };
+    };
+    asn: {
+        number: number | null;
+        name: string | null;
+    };
+    completion_time: {
+        miliseconds: number | null;
+        seconds: number | null;
+    };
+}
+interface SingleConvertResponseInterface$2 {
+    success: boolean;
+    message: string;
+    code: number;
+    data: Ip | null;
+    _req: {
+        reqId: string | null;
+        resTime: number;
+    };
+}
+interface InitOptions$1 {
+    clientRuntimeMessage?: boolean;
+    versionUpdateMessage?: boolean;
+}
+interface MultipleConvertResponseInterface$1 {
+    success: boolean;
+    message: string;
+    code: number;
+    data: Array<{
+        ip: string;
+        conversion: Ip | null;
+    }>;
+    _req: {
+        reqId: string | null;
+        resTime: number;
+    };
+}
+type ConvertIPProps$1 = {
+    ip: string;
+};
+type ConvertIPsProps$1 = {
+    ips: Array<string>;
+};
+
+/**
+ * Get geo information from an IP address.
+ *
+ * The function fetches detailed geographical and connection-related information
+ * for a given IP address. The returned data includes properties such as continent,
+ * country, city, timezone, ASN details, and completion time.
+ *
+ * @param props - The properties object containing the IP address.
+ * @param props.ip - The IP address to retrieve geo information for.
+ * @returns {Promise<SingleConvertResponseInterface | null>} A Promise resolving to a {@link SingleConvertResponseInterface} containing the response wrapper with geo and connection details, or `null` if the request fails or no response is received.
+*/
+type ConvertIPProps = Expand<ConvertIPProps$1>;
+type SingleConvertResponseInterface$1 = Expand<SingleConvertResponseInterface$2>;
+declare const ConvertIP: (options: ConvertIPProps) => Promise<SingleConvertResponseInterface$1 | null>;
+
+/**
+ * Get geo information from multiple IP addresses.
+ *
+ * The function fetches detailed geographical and connection-related information
+ * for an array of IP addresses. The returned data includes an array of conversions,
+ * each containing the IP and its geo data (continent, country, city, timezone, ASN details, etc).
+ *
+ * @param props - The properties object containing the IP addresses.
+ * @param props.ips - An array of IP addresses to retrieve geo information for.
+ * @returns {Promise<MultipleConvertResponseInterface | null>} A Promise resolving to a {@link MultipleConvertResponseInterface} containing the response wrapper with an array of geo conversions, or `null` if the request fails or no response is received.
+*/
+type ConvertIPsProps = Expand<ConvertIPsProps$1>;
+type MultipleConvertResponseInterface = Expand<MultipleConvertResponseInterface$1>;
+type SingleConvertResponseInterface = Expand<SingleConvertResponseInterface$2>;
+declare const ConvertIPs: (props: ConvertIPsProps) => Promise<MultipleConvertResponseInterface | SingleConvertResponseInterface | null>;
+
+/**
+ * Initializes the SDK with the given API key.
+ *
+ * @param {string} key - The API key used to authenticate with the Ip2Geo.
+ * @param {InitOptions} [options] - The options for the initialization (optional).
+ * @param {boolean} [options.clientRuntimeMessage=true] - Whether to display client runtime messages.
+ * @param {boolean} [options.versionUpdateMessage=true] - Whether to display version update messages.
+ * @returns {boolean} - A boolean that indicates if the initialization was successful.
+*/
+type InitOptions = Expand<InitOptions$1>;
+declare const Init: (key: string, options?: InitOptions) => Promise<boolean>;
+
+declare const Ip2Geo: {
+    ConvertIPs: (props: {
+        ips: string[];
+    }) => Promise<{
+        success: boolean;
+        message: string;
+        code: number;
+        data: {
+            ip: string;
+            conversion: {
+                ip: string | null;
+                type: IpTypes | null;
+                is_eu: boolean | null;
+                continent: {
+                    name: string | null;
+                    code: string | null;
+                    country: {
+                        name: string | null;
+                        code: string | null;
+                        phone_code: string | null;
+                        capital: string | null;
+                        tld: string | null;
+                        city: {
+                            name: string | null;
+                            latitude: number | null;
+                            longitude: number | null;
+                            postal_code: string | null;
+                            timezone: {
+                                name: string | null;
+                                time_now: string | null;
+                            };
+                        };
+                        flag: {
+                            img: string | null;
+                            emoji: string | null;
+                            emoji_unicode: string | null;
+                        };
+                        currency: {
+                            name: string | null;
+                            code: string | null;
+                            symbol: string | null;
+                        };
+                    };
+                };
+                asn: {
+                    number: number | null;
+                    name: string | null;
+                };
+                completion_time: {
+                    miliseconds: number | null;
+                    seconds: number | null;
+                };
+            } | null;
+        }[];
+        _req: {
+            reqId: string | null;
+            resTime: number;
+        };
+    } | {
+        success: boolean;
+        message: string;
+        code: number;
+        data: {
+            ip: string | null;
+            type: IpTypes | null;
+            is_eu: boolean | null;
+            continent: {
+                name: string | null;
+                code: string | null;
+                country: {
+                    name: string | null;
+                    code: string | null;
+                    phone_code: string | null;
+                    capital: string | null;
+                    tld: string | null;
+                    city: {
+                        name: string | null;
+                        latitude: number | null;
+                        longitude: number | null;
+                        postal_code: string | null;
+                        timezone: {
+                            name: string | null;
+                            time_now: string | null;
+                        };
+                    };
+                    flag: {
+                        img: string | null;
+                        emoji: string | null;
+                        emoji_unicode: string | null;
+                    };
+                    currency: {
+                        name: string | null;
+                        code: string | null;
+                        symbol: string | null;
+                    };
+                };
+            };
+            asn: {
+                number: number | null;
+                name: string | null;
+            };
+            completion_time: {
+                miliseconds: number | null;
+                seconds: number | null;
+            };
+        } | null;
+        _req: {
+            reqId: string | null;
+            resTime: number;
+        };
+    } | null>;
+    ConvertIP: (options: {
+        ip: string;
+    }) => Promise<{
+        success: boolean;
+        message: string;
+        code: number;
+        data: {
+            ip: string | null;
+            type: IpTypes | null;
+            is_eu: boolean | null;
+            continent: {
+                name: string | null;
+                code: string | null;
+                country: {
+                    name: string | null;
+                    code: string | null;
+                    phone_code: string | null;
+                    capital: string | null;
+                    tld: string | null;
+                    city: {
+                        name: string | null;
+                        latitude: number | null;
+                        longitude: number | null;
+                        postal_code: string | null;
+                        timezone: {
+                            name: string | null;
+                            time_now: string | null;
+                        };
+                    };
+                    flag: {
+                        img: string | null;
+                        emoji: string | null;
+                        emoji_unicode: string | null;
+                    };
+                    currency: {
+                        name: string | null;
+                        code: string | null;
+                        symbol: string | null;
+                    };
+                };
+            };
+            asn: {
+                number: number | null;
+                name: string | null;
+            };
+            completion_time: {
+                miliseconds: number | null;
+                seconds: number | null;
+            };
+        } | null;
+        _req: {
+            reqId: string | null;
+            resTime: number;
+        };
+    } | null>;
+    Init: (key: string, options?: {
+        clientRuntimeMessage?: boolean | undefined;
+        versionUpdateMessage?: boolean | undefined;
+    }) => Promise<boolean>;
+};
+
+export { ConvertIP, ConvertIPs, Init, Ip2Geo as default };
+export type { ConvertIPProps$1 as ConvertIPProps, ConvertIPsProps$1 as ConvertIPsProps, InitOptions$1 as InitOptions, Ip, MultipleConvertResponseInterface$1 as MultipleConvertResponseInterface, SingleConvertResponseInterface$2 as SingleConvertResponseInterface };

package/package.json

@@ -0,0 +1,49 @@
+{
+    "name": "@ip2geo/sdk",
+    "version": "0.0.1",
+    "author": "Ip2Geo",
+    "description": "Programmatically convert IP's into GEO location data.",
+    "type": "module",
+    "main": "/cjs/index.cjs",
+    "module": "/esm/index.js",
+    "types": "./index.d.ts",
+    "keywords": [
+        "geo ip",
+        "ip geolocation",
+        "ip to location",
+        "ip location",
+        "ip geo",
+        "geolocation lookup",
+        "ip tracker",
+        "client ip geolocation",
+        "server ip geolocation",
+        "geoip api",
+        "ip data",
+        "geolocation api",
+        "ip info",
+        "ip location api",
+        "ip lookup",
+        "geo location",
+        "ip mapping",
+        "ip coordinates",
+        "location from ip",
+        "lightweight geolocation",
+        "tiny geoip",
+        "type safe geo",
+        "ip to country",
+        "geoip client side",
+        "geoip server side",
+        "online ip lookup",
+        "javascript geoip",
+        "bun geoip",
+        "nodejs ip geolocation",
+        "ip2geo"
+    ],
+    "exports": {
+        ".": {
+            "import": "./esm/index.js",
+            "require": "./cjs/index.cjs",
+            "types": "./index.d.ts"
+        }
+    }
+}