Chore/minor-improvements (#11)

* feat: add jest test ci workflow

* chore: improved .vscode settings

* chore: removed `@alessiofrittoli/post-install-scripts`

* chore: improved project structure

* feat: add `getRequestIp` utility function

* feat: add `readJsonBody` utility function

.github/rulesets/Default branch ruleset.json

@@ -36,6 +36,7 @@
 			"parameters": {
 				"required_approving_review_count": 0,
 				"dismiss_stale_reviews_on_push": true,
+				"require_code_owner_review": true,
 				"require_last_push_approval": true,
 				"required_review_thread_resolution": true,
 				"automatic_copilot_code_review_enabled": false,
@@ -50,7 +51,12 @@
 			"parameters": {
 				"strict_required_status_checks_policy": true,
 				"do_not_enforce_on_create": false,
-				"required_status_checks": []
+				"required_status_checks": [
+					{
+						"context": "Run Unit Tests",
+						"integration_id": 15368
+					}
+				]
 			}
 		},
 		{

.github/rulesets/Tagging ruleset.json

@@ -36,7 +36,12 @@
 			"parameters": {
 				"strict_required_status_checks_policy": true,
 				"do_not_enforce_on_create": false,
-				"required_status_checks": []
+				"required_status_checks": [
+					{
+						"context": "Run Unit Tests",
+						"integration_id": 15368
+					}
+				]
 			}
 		}
 	],

.github/workflows/tests-ci.yml

@@ -0,0 +1,25 @@
+on: [ "push", "pull_request" ]
+
+name: Unit Tests
+
+jobs:
+  test:
+    name: Run Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+
+    - uses: actions/checkout@v4
+
+    - name: Use Node.js 20.x
+      uses: actions/setup-node@v3
+      with:
+        node-version: 20.x
+
+    - name: Install dependencies
+      run: |
+        npm install -g pnpm@latest
+        pnpm i
+
+    - name: Run tests
+      run: |
+        pnpm test:ci:coverage

.vscode/extensions.json

@@ -6,6 +6,7 @@
 	"recommendations": [
 		"dbaeumer.vscode-eslint",
 		"davidanson.vscode-markdownlint",
+		"Orta.vscode-jest",
 	],
 	// List of extensions recommended by VS Code that should not be recommended for users of this workspace.
 	"unwantedRecommendations": []

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+	"configurations": [
+		{
+			"type": "node",
+			"name": "Debug Tests",
+			"request": "launch",
+			"args": [
+				"test",
+				"--",
+				"--runInBand",
+				"--watchAll=false",
+				"--testNamePattern",
+				"${jest.testNamePattern}",
+				"--runTestsByPath",
+				"${jest.testFile}"
+			],
+			"console": "integratedTerminal",
+			"internalConsoleOptions": "neverOpen",
+			"disableOptimisticBPs": true,
+			"runtimeExecutable": "pnpm"
+		}
+	]
+}

.vscode/settings.json

@@ -7,5 +7,7 @@
 		"statusBar.border":"#484848",
 		"statusBar.foreground": "#F0F0F0",
 		"activityBar.activeBorder": "#484848",
+		"activityBarBadge.foreground":"#484848",
+		"activityBarBadge.background":"#F0F0F0",
 	},
 }

package.json

@@ -22,7 +22,7 @@
 		"type": "git",
 		"url": "git+https://github.com/alessiofrittoli/next-api.git"
 	},
-	"main": "./dist/index.cjs",
+	"main": "./dist/index.js",
 	"module": "./dist/index.mjs",
 	"types": "./dist/index.d.ts",
 	"files": [
@@ -31,24 +31,32 @@
 	],
 	"exports": {
 		".": {
+			"types": "./dist/index.d.ts",
 			"import": "./dist/index.mjs",
-			"require": "./dist/index.cjs"
+			"require": "./dist/index.js"
 		},
 		"./error": {
 			"types": "./dist/error/index.d.ts",
 			"import": "./dist/error/index.mjs",
-			"require": "./dist/error/index.cjs"
+			"require": "./dist/error/index.js"
 		},
-		"./server": {
-			"types": "./dist/server/index.d.ts",
-			"import": "./dist/server/index.mjs",
-			"require": "./dist/server/index.cjs"
+		"./request": {
+			"types": "./dist/request/index.d.ts",
+			"import": "./dist/request/index.mjs",
+			"require": "./dist/request/index.js"
+		},
+		"./response": {
+			"types": "./dist/response/index.d.ts",
+			"import": "./dist/response/index.mjs",
+			"require": "./dist/response/index.js"
+		},
+		"./route-wrappers": {
+			"types": "./dist/route-wrappers/index.d.ts",
+			"import": "./dist/route-wrappers/index.mjs",
+			"require": "./dist/route-wrappers/index.js"
 		},
 		"./types": {
 			"types": "./dist/types/index.d.ts"
-		},
-		"./types/api": {
-			"types": "./dist/types/api.d.ts"
 		}
 	},
 	"sideEffects": false,
@@ -74,7 +82,7 @@
 		"test:next-response": "pnpm test next-response.test.ts"
 	},
 	"peerDependencies": {
-		"next": ">=14.0.0"
+		"next": ">=15.0.0"
 	},
 	"devDependencies": {
 		"@eslint/js": "^9.17.0",
@@ -100,7 +108,7 @@
 		"@alessiofrittoli/exception": "^2.0.0",
 		"@alessiofrittoli/http-server-status": "^1.0.0",
 		"@alessiofrittoli/node-scripts": "^2.2.1",
-		"@alessiofrittoli/post-install-scripts": "^0.3.0",
+		"@alessiofrittoli/stream-reader": "^1.1.0",
 		"@alessiofrittoli/type-utils": "^1.5.0",
 		"@alessiofrittoli/url-utils": "^1.0.0"
 	}

src/error/index.ts

@@ -1,11 +1,9 @@
-import Exception from '@alessiofrittoli/exception/code'
+import { ErrorCode as Exception } from '@alessiofrittoli/exception/code'
 
 export enum Next
 {
 	// other custom error codes...
 }
 
-const ErrorCode	= { Exception, Next }
-type ErrorCode	= MergedEnumValue<typeof ErrorCode>
-
-export default ErrorCode
+export const ErrorCode	= { Exception, Next }
+export type ErrorCode	= MergedEnumValue<typeof ErrorCode>

src/index.ts

@@ -1,3 +1,5 @@
-export { default as NextResponse } from './server'
-export { default as ErrorCode } from './error'
+export * from '@/error'
+export * from '@/request'
+export * from '@/response'
+export * from '@/route-wrappers'
 export type * from './types'

src/request/index.ts

@@ -0,0 +1,20 @@
+import type { NextRequest } from 'next/server'
+
+export * from './read'
+
+
+/**
+ * Get request IP address.
+ *
+ * @param	request The NextRequest Instance.
+ * @returns	The Request IP address.
+ */
+export const getRequestIp = async ( request?: NextRequest ) => {
+
+	const headers		= request?.headers || await ( await import( 'next/headers' ) ).headers()
+	const forwarded		= headers.get( 'X-Forwarded-For' )?.replace( /\s/g, '' ).split( ',' ).at( -1 )
+	const realIp		= headers.get( 'X-Real-Ip' )?.replace( /\s/g, '' ).split( ',' ).at( -1 )
+
+	return forwarded || realIp || null
+
+}

src/request/read.ts

@@ -0,0 +1,24 @@
+import type { Api } from '@/types/api'
+
+/**
+ * Read Incoming Request Json Body.
+ * 
+ * @param	body The Request|Body instance.
+ * @returns	The Awaited result of {@link Body.json}, null if Body is empty, locked or invalid.
+ */
+export const readJsonBody = async <
+	T extends Api.Route.RequestBody = Api.Route.RequestBody
+>( body: Api.Route.Request<T> ) => {
+
+	try {
+
+		return await body.clone().json<T>()
+
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	} catch ( error ) {
+
+		return null
+
+	}
+
+}