Merge remote-tracking branch 'upstream/main' into server-null-fix

Author: armada45-pixel

example/issue.ts

@@ -1,5 +1,4 @@
 import { Elysia } from "elysia"
-// import { defaultOptions, ip } from "elysia-ip"
 import { defaultOptions, ip } from "../src/index"
 
 import type { Server } from "bun"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "elysia-ip",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "type": "module",
   "author": {
     "name": "Gaurish Sethia",

src/constants/headerlist.ts src/constants.ts

@@ -1,4 +1,4 @@
-import { IPHeaders } from "../types/header"
+import { Options, IPHeaders } from "./types"
 
 export const headersToCheck: IPHeaders[] = [
   "x-real-ip", // Nginx proxy/FastCGI
@@ -14,3 +14,9 @@ export const headersToCheck: IPHeaders[] = [
   "true-client-ip", // Akamai and Cloudflare
   "cf-pseudo-ipv4", // Cloudflare
 ]
+
+export const defaultOptions: Options = {
+  headersOnly: false,
+  checkHeaders: headersToCheck,
+  injectServer: (app) => app.server,
+}

src/constants/defaultOptions.ts

@@ -1,9 +1,5 @@
 export { getIP } from "./services/getip"
 export { plugin as ip } from "./services/plugin"
 
-export { defaultOptions } from "./constants/defaultOptions"
-export { headersToCheck } from "./constants/headerlist"
-
-export type { IPHeaders } from "./types/header"
-export type { Options } from "./types/options"
-export type { injectServer } from "./types/injectserver"
+export { defaultOptions, headersToCheck } from "./constants"
+export type { IPHeaders, Options, InjectServer} from "./types"

src/index.ts

@@ -1,5 +1,5 @@
-import { headersToCheck } from "../constants/headerlist"
-import { IPHeaders } from "../types/header"
+import { headersToCheck } from "../constants"
+import { IPHeaders } from "../types"
 
 export const getIP = (
   headers: Headers,

src/services/getip.ts

@@ -1,7 +1,7 @@
 import { Elysia } from "elysia"
-import { getIP } from "../services/getip"
-import { defaultOptions } from "../constants/defaultOptions"
-import type { Options } from "../types/options"
+import { getIP } from "./getip"
+import { defaultOptions } from "../constants"
+import type { Options } from "../types"
 
 export const plugin = (userOptions?: Partial<Options>) => (app: Elysia) => {
   const options: Options = {

src/services/plugin.ts

@@ -1,5 +1,22 @@
-import type { IPHeaders } from "./header"
-import type { injectServer } from "./injectserver"
+import type { Server } from "bun"
+import type Elysia from "elysia"
+
+export type IPHeaders =
+  | "x-real-ip"
+  | "x-client-ip"
+  | "cf-connecting-ip"
+  | "fastly-client-ip"
+  | "x-cluster-client-ip"
+  | "x-forwarded"
+  | "forwarded-for"
+  | "forwarded"
+  | "x-forwarded"
+  | "appengine-user-ip"
+  | "true-client-ip"
+  | "cf-pseudo-ipv4"
+  | (string & {})
+
+export type InjectServer = (app: Elysia) => Server | null
 
 export interface Options {
   /**
@@ -15,5 +32,5 @@ export interface Options {
   /**
    *
    */
-  injectServer: injectServer
+  injectServer: InjectServer
 }