@k03mad/ip2geo 21.0.0 → 21.0.2

package/api.d.ts

@@ -0,0 +1,35 @@
+export interface ReqOutput {
+  ip?: string;
+  continent?: string;
+  continentCode?: string;
+  country?: string;
+  countryCode?: string;
+  countryEmoji?: string;
+  region?: string;
+  regionCode?: string;
+  city?: string;
+  connectionAsn?: number;
+  connectionOrg?: string;
+  connectionIsp?: string;
+  connectionDomain?: string;
+}
+
+export interface ReqInput {
+  ip?: string;
+  cacheDir?: string;
+  cacheFileName?: string;
+  cacheFileSeparator?: string;
+  cacheFileNewline?: string;
+  cacheMap?: Map<string, ReqOutput>;
+  cacheMapMaxEntries?: number;
+}
+
+export const cacheStorage: Map<string, ReqOutput>;
+
+export const DEFAULT_CACHE_FILE_DIR: string;
+export const DEFAULT_CACHE_FILE_NAME: string;
+export const DEFAULT_CACHE_FILE_SEPARATOR: string;
+export const DEFAULT_CACHE_FILE_NEWLINE: string;
+export const DEFAULT_CACHE_MAP_MAX_ENTRIES: number;
+
+export const ip2geo: (opts?: ReqInput) => Promise<ReqOutput>;

package/app/api.ts

@@ -1,6 +1,8 @@
 import os from 'node:os';
 import path from 'node:path';
 
+import type {ReqInput, ReqOutput} from '../api.d.ts';
+
 import {
   collectOutputData,
   readFromFsCache,
@@ -8,7 +10,6 @@ import {
   writeToFsCache,
   writeToMapCache,
 } from './helpers/cache.ts';
-import type {ReqOutput} from './types.ts';
 
 const API = 'https://ipwho.is/';
 
@@ -18,16 +19,6 @@ export const DEFAULT_CACHE_FILE_SEPARATOR = ';;';
 export const DEFAULT_CACHE_FILE_NEWLINE = '\n';
 export const DEFAULT_CACHE_MAP_MAX_ENTRIES = Number.POSITIVE_INFINITY;
 
-export interface ReqInput {
-  ip?: string;
-  cacheDir?: string;
-  cacheFileName?: string;
-  cacheFileSeparator?: string;
-  cacheFileNewline?: string;
-  cacheMap?: Map<string, ReqOutput>;
-  cacheMapMaxEntries?: number;
-}
-
 interface ApiResponseBody {
   ip?: string;
   continent?: string;

package/app/helpers/cache.ts

@@ -4,7 +4,7 @@ import path from 'node:path';
 import _debug from 'debug';
 import {isIP} from 'is-ip';
 
-import type {ReqOutput} from '../types.ts';
+import type {ReqOutput} from '../../api.d.ts';
 
 import {getArrayDups} from './utils.ts';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k03mad/ip2geo",
-  "version": "21.0.0",
+  "version": "21.0.2",
   "description": "GeoIP library",
   "license": "MIT",
   "maintainers": [
@@ -15,6 +15,7 @@
   },
   "type": "module",
   "main": "api.js",
+  "types": "api.d.ts",
   "scripts": {
     "lint": "oxlint && oxfmt -c node_modules/@k03mad/oxlint-config/.oxfmtrc.json --check && tsc --noEmit",
     "test": "rm -rfv ./.geoip && node --test tests/*.ts",
@@ -27,7 +28,7 @@
     "tsx": "4.23.8"
   },
   "devDependencies": {
-    "@k03mad/oxlint-config": "0.12.1",
+    "@k03mad/oxlint-config": "0.12.2",
     "@tsconfig/strictest": "2.0.8",
     "@types/debug": "4.1.13",
     "@types/node": "26.1.2",

package/tests/cache-file-entries.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert/strict';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.ts';
 import {REQUEST_IPV4} from './shared/consts.ts';

package/tests/cache-file-modify.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert/strict';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.ts';
 import {REQUEST_IPV4} from './shared/consts.ts';

package/tests/cache-file-subfolder.ts

@@ -2,8 +2,8 @@ import assert from 'node:assert/strict';
 import path from 'node:path';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.ts';
 import {REQUEST_IPV4} from './shared/consts.ts';

package/tests/cache-map-entries.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert/strict';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.ts';
 import {REQUEST_IPV4, REQUEST_IPV6} from './shared/consts.ts';

package/tests/cache-map-max-entries.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert/strict';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.ts';
 import {removeCacheFolder} from './shared/fs.ts';

package/tests/default.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert/strict';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {cacheStorage, ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename} from './helpers/path.ts';
 import {REQUEST_IPV4} from './shared/consts.ts';

package/tests/ip-multi-requests-cache.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert/strict';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.ts';
 import {REQUEST_IPV4} from './shared/consts.ts';

package/tests/ip-no-data.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert/strict';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.ts';
 import {REQUEST_IPV4} from './shared/consts.ts';

package/tests/ip-v6.ts

@@ -1,8 +1,8 @@
 import assert from 'node:assert/strict';
 import {describe, it} from 'node:test';
 
+import type {ReqOutput} from '../api.d.ts';
 import {ip2geo} from '../app/api.ts';
-import type {ReqOutput} from '../app/types.ts';
 
 import {getCurrentFilename, getTestFolder} from './helpers/path.ts';
 import {REQUEST_IPV6} from './shared/consts.ts';

package/tests/shared/consts.ts

@@ -1,4 +1,4 @@
-import type {ReqOutput} from '../../app/types.ts';
+import type {ReqOutput} from '../../api.d.ts';
 
 export const REQUEST_IPV4: ReqOutput = {
   ip: '8.8.8.8',

package/tests/shared/fs.ts

@@ -2,13 +2,13 @@ import assert from 'node:assert/strict';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
+import type {ReqOutput} from '../../api.d.ts';
 import {
   DEFAULT_CACHE_FILE_DIR,
   DEFAULT_CACHE_FILE_NAME,
   DEFAULT_CACHE_FILE_NEWLINE,
   DEFAULT_CACHE_FILE_SEPARATOR,
 } from '../../app/api.ts';
-import type {ReqOutput} from '../../app/types.ts';
 
 interface CheckCacheFileOpts {
   cacheDir?: string;

package/app/types.ts

@@ -1,15 +0,0 @@
-export interface ReqOutput {
-  ip?: string;
-  continent?: string;
-  continentCode?: string;
-  country?: string;
-  countryCode?: string;
-  countryEmoji?: string;
-  region?: string;
-  regionCode?: string;
-  city?: string;
-  connectionAsn?: number;
-  connectionOrg?: string;
-  connectionIsp?: string;
-  connectionDomain?: string;
-}