Initial commit: Farm Auth Service with multi-device support and device management
This commit is contained in:
commit
9dd376df76
|
|
@ -0,0 +1,38 @@
|
||||||
|
# Dependencies
|
||||||
|
node_modules/
|
||||||
|
package-lock.json
|
||||||
|
|
||||||
|
# Environment variables
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.*.local
|
||||||
|
|
||||||
|
# Logs
|
||||||
|
logs
|
||||||
|
*.log
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
|
||||||
|
# OS files
|
||||||
|
.DS_Store
|
||||||
|
Thumbs.db
|
||||||
|
|
||||||
|
# IDE files
|
||||||
|
.vscode/
|
||||||
|
.idea/
|
||||||
|
*.swp
|
||||||
|
*.swo
|
||||||
|
*~
|
||||||
|
|
||||||
|
# Database
|
||||||
|
*.db
|
||||||
|
*.sqlite
|
||||||
|
|
||||||
|
# Build outputs
|
||||||
|
dist/
|
||||||
|
build/
|
||||||
|
|
||||||
|
# Temporary files
|
||||||
|
*.tmp
|
||||||
|
*.temp
|
||||||
|
|
@ -0,0 +1,566 @@
|
||||||
|
# Farm Auth Service - API Integration Guide
|
||||||
|
|
||||||
|
Quick reference for integrating the Farm Auth Service into Kotlin mobile applications.
|
||||||
|
|
||||||
|
## Base URL
|
||||||
|
|
||||||
|
```
|
||||||
|
http://localhost:3000 (development)
|
||||||
|
https://your-domain.com (production)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Authentication Flow
|
||||||
|
|
||||||
|
1. **Request OTP** → User enters phone number
|
||||||
|
2. **Verify OTP** → User enters code, receives tokens
|
||||||
|
3. **Use Access Token** → Include in `Authorization` header for protected endpoints
|
||||||
|
4. **Refresh Token** → When access token expires, get new tokens
|
||||||
|
5. **Logout** → Revoke refresh token
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## API Endpoints
|
||||||
|
|
||||||
|
### 1. Request OTP
|
||||||
|
|
||||||
|
**Endpoint:** `POST /auth/request-otp`
|
||||||
|
|
||||||
|
**Request:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"phone_number": "+919876543210"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (200):**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Kotlin Example:**
|
||||||
|
```kotlin
|
||||||
|
data class RequestOtpRequest(val phone_number: String)
|
||||||
|
data class RequestOtpResponse(val ok: Boolean)
|
||||||
|
|
||||||
|
suspend fun requestOtp(phoneNumber: String): Result<RequestOtpResponse> {
|
||||||
|
val request = RequestOtpRequest(phoneNumber)
|
||||||
|
return apiClient.post("/auth/request-otp", request)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** Phone numbers are auto-normalized:
|
||||||
|
- `9876543210` → `+919876543210` (10-digit assumed as Indian)
|
||||||
|
- `+919876543210` → `+919876543210` (already formatted)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Verify OTP
|
||||||
|
|
||||||
|
**Endpoint:** `POST /auth/verify-otp`
|
||||||
|
|
||||||
|
**Request:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"code": "123456",
|
||||||
|
"device_id": "android-installation-id-123",
|
||||||
|
"device_info": {
|
||||||
|
"platform": "android",
|
||||||
|
"model": "Samsung SM-M326B",
|
||||||
|
"os_version": "Android 14",
|
||||||
|
"app_version": "1.0.0",
|
||||||
|
"language_code": "en-IN",
|
||||||
|
"timezone": "Asia/Kolkata"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (200):**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"user": {
|
||||||
|
"id": "uuid-here",
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"name": null,
|
||||||
|
"role": "user",
|
||||||
|
"user_type": null
|
||||||
|
},
|
||||||
|
"access_token": "eyJhbGc...",
|
||||||
|
"refresh_token": "eyJhbGc...",
|
||||||
|
"needs_profile": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Kotlin Example:**
|
||||||
|
```kotlin
|
||||||
|
data class DeviceInfo(
|
||||||
|
val platform: String,
|
||||||
|
val model: String? = null,
|
||||||
|
val os_version: String? = null,
|
||||||
|
val app_version: String? = null,
|
||||||
|
val language_code: String? = null,
|
||||||
|
val timezone: String? = null
|
||||||
|
)
|
||||||
|
|
||||||
|
data class VerifyOtpRequest(
|
||||||
|
val phone_number: String,
|
||||||
|
val code: String,
|
||||||
|
val device_id: String,
|
||||||
|
val device_info: DeviceInfo? = null
|
||||||
|
)
|
||||||
|
|
||||||
|
data class User(
|
||||||
|
val id: String,
|
||||||
|
val phone_number: String,
|
||||||
|
val name: String?,
|
||||||
|
val role: String,
|
||||||
|
val user_type: String?
|
||||||
|
)
|
||||||
|
|
||||||
|
data class VerifyOtpResponse(
|
||||||
|
val user: User,
|
||||||
|
val access_token: String,
|
||||||
|
val refresh_token: String,
|
||||||
|
val needs_profile: Boolean
|
||||||
|
)
|
||||||
|
|
||||||
|
suspend fun verifyOtp(
|
||||||
|
phoneNumber: String,
|
||||||
|
code: String,
|
||||||
|
deviceId: String,
|
||||||
|
deviceInfo: DeviceInfo? = null
|
||||||
|
): Result<VerifyOtpResponse> {
|
||||||
|
val request = VerifyOtpRequest(phoneNumber, code, deviceId, deviceInfo)
|
||||||
|
return apiClient.post("/auth/verify-otp", request)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Error (400):**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"error": "Invalid or expired OTP"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. Refresh Token
|
||||||
|
|
||||||
|
**Endpoint:** `POST /auth/refresh`
|
||||||
|
|
||||||
|
**Request:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"refresh_token": "eyJhbGc..."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (200):**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"access_token": "eyJhbGc...",
|
||||||
|
"refresh_token": "eyJhbGc..."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Kotlin Example:**
|
||||||
|
```kotlin
|
||||||
|
data class RefreshRequest(val refresh_token: String)
|
||||||
|
data class RefreshResponse(val access_token: String, val refresh_token: String)
|
||||||
|
|
||||||
|
suspend fun refreshToken(refreshToken: String): Result<RefreshResponse> {
|
||||||
|
val request = RefreshRequest(refreshToken)
|
||||||
|
return apiClient.post("/auth/refresh", request)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Note:** Refresh tokens rotate on each use. Always save the new `refresh_token`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. Update Profile
|
||||||
|
|
||||||
|
**Endpoint:** `PUT /users/me`
|
||||||
|
|
||||||
|
**Headers:**
|
||||||
|
```
|
||||||
|
Authorization: Bearer <access_token>
|
||||||
|
```
|
||||||
|
|
||||||
|
**Request:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "John Doe",
|
||||||
|
"user_type": "seller"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (200):**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "uuid-here",
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"name": "John Doe",
|
||||||
|
"role": "user",
|
||||||
|
"user_type": "seller"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**user_type values:** `seller`, `buyer`, `service_provider`
|
||||||
|
|
||||||
|
**Kotlin Example:**
|
||||||
|
```kotlin
|
||||||
|
data class UpdateProfileRequest(val name: String, val user_type: String)
|
||||||
|
data class UpdateProfileResponse(
|
||||||
|
val id: String,
|
||||||
|
val phone_number: String,
|
||||||
|
val name: String?,
|
||||||
|
val role: String,
|
||||||
|
val user_type: String?
|
||||||
|
)
|
||||||
|
|
||||||
|
suspend fun updateProfile(
|
||||||
|
name: String,
|
||||||
|
userType: String,
|
||||||
|
accessToken: String
|
||||||
|
): Result<UpdateProfileResponse> {
|
||||||
|
val request = UpdateProfileRequest(name, userType)
|
||||||
|
return apiClient.put("/users/me", request, accessToken)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5. Logout
|
||||||
|
|
||||||
|
**Endpoint:** `POST /auth/logout`
|
||||||
|
|
||||||
|
**Request:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"refresh_token": "eyJhbGc..."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response (200):**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Kotlin Example:**
|
||||||
|
```kotlin
|
||||||
|
suspend fun logout(refreshToken: String): Result<Unit> {
|
||||||
|
val request = RefreshRequest(refreshToken)
|
||||||
|
return apiClient.post("/auth/logout", request)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Complete Kotlin Integration Example
|
||||||
|
|
||||||
|
### 1. API Client Setup
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
import kotlinx.coroutines.*
|
||||||
|
import kotlinx.serialization.*
|
||||||
|
import kotlinx.serialization.json.*
|
||||||
|
import io.ktor.client.*
|
||||||
|
import io.ktor.client.call.*
|
||||||
|
import io.ktor.client.request.*
|
||||||
|
import io.ktor.client.statement.*
|
||||||
|
import io.ktor.http.*
|
||||||
|
|
||||||
|
class AuthApiClient(private val baseUrl: String) {
|
||||||
|
private val client = HttpClient {
|
||||||
|
install(JsonFeature) {
|
||||||
|
serializer = KotlinxSerializationJson()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
suspend fun requestOtp(phoneNumber: String): Result<RequestOtpResponse> {
|
||||||
|
return try {
|
||||||
|
val response = client.post("$baseUrl/auth/request-otp") {
|
||||||
|
contentType(ContentType.Application.Json)
|
||||||
|
setBody(JsonObject(mapOf("phone_number" to JsonPrimitive(phoneNumber))))
|
||||||
|
}
|
||||||
|
Result.success(response.body())
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Result.failure(e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
suspend fun verifyOtp(
|
||||||
|
phoneNumber: String,
|
||||||
|
code: String,
|
||||||
|
deviceId: String
|
||||||
|
): Result<VerifyOtpResponse> {
|
||||||
|
return try {
|
||||||
|
val request = VerifyOtpRequest(phoneNumber, code, deviceId, getDeviceInfo())
|
||||||
|
val response = client.post("$baseUrl/auth/verify-otp") {
|
||||||
|
contentType(ContentType.Application.Json)
|
||||||
|
setBody(request)
|
||||||
|
}
|
||||||
|
Result.success(response.body())
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Result.failure(e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
suspend fun refreshToken(refreshToken: String): Result<RefreshResponse> {
|
||||||
|
return try {
|
||||||
|
val request = RefreshRequest(refreshToken)
|
||||||
|
val response = client.post("$baseUrl/auth/refresh") {
|
||||||
|
contentType(ContentType.Application.Json)
|
||||||
|
setBody(request)
|
||||||
|
}
|
||||||
|
Result.success(response.body())
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Result.failure(e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
suspend fun updateProfile(
|
||||||
|
name: String,
|
||||||
|
userType: String,
|
||||||
|
accessToken: String
|
||||||
|
): Result<UpdateProfileResponse> {
|
||||||
|
return try {
|
||||||
|
val request = UpdateProfileRequest(name, userType)
|
||||||
|
val response = client.put("$baseUrl/users/me") {
|
||||||
|
contentType(ContentType.Application.Json)
|
||||||
|
header("Authorization", "Bearer $accessToken")
|
||||||
|
setBody(request)
|
||||||
|
}
|
||||||
|
Result.success(response.body())
|
||||||
|
} catch (e: Exception) {
|
||||||
|
Result.failure(e)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun getDeviceInfo(): DeviceInfo {
|
||||||
|
return DeviceInfo(
|
||||||
|
platform = "android",
|
||||||
|
model = Build.MODEL,
|
||||||
|
os_version = Build.VERSION.RELEASE,
|
||||||
|
app_version = BuildConfig.VERSION_NAME,
|
||||||
|
language_code = Locale.getDefault().toString(),
|
||||||
|
timezone = TimeZone.getDefault().id
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Token Storage (Secure SharedPreferences)
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
import android.content.Context
|
||||||
|
import android.content.SharedPreferences
|
||||||
|
import androidx.security.crypto.EncryptedSharedPreferences
|
||||||
|
import androidx.security.crypto.MasterKey
|
||||||
|
|
||||||
|
class TokenManager(context: Context) {
|
||||||
|
private val masterKey = MasterKey.Builder(context)
|
||||||
|
.setKeyScheme(MasterKey.KeyScheme.AES256_GCM)
|
||||||
|
.build()
|
||||||
|
|
||||||
|
private val prefs: SharedPreferences = EncryptedSharedPreferences.create(
|
||||||
|
context,
|
||||||
|
"auth_tokens",
|
||||||
|
masterKey,
|
||||||
|
EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
|
||||||
|
EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
|
||||||
|
)
|
||||||
|
|
||||||
|
fun saveTokens(accessToken: String, refreshToken: String) {
|
||||||
|
prefs.edit().apply {
|
||||||
|
putString("access_token", accessToken)
|
||||||
|
putString("refresh_token", refreshToken)
|
||||||
|
apply()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fun getAccessToken(): String? = prefs.getString("access_token", null)
|
||||||
|
fun getRefreshToken(): String? = prefs.getString("refresh_token", null)
|
||||||
|
|
||||||
|
fun clearTokens() {
|
||||||
|
prefs.edit().clear().apply()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Authentication Manager
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
class AuthManager(
|
||||||
|
private val apiClient: AuthApiClient,
|
||||||
|
private val tokenManager: TokenManager
|
||||||
|
) {
|
||||||
|
suspend fun login(phoneNumber: String, code: String): Result<User> {
|
||||||
|
val deviceId = getDeviceId()
|
||||||
|
return apiClient.verifyOtp(phoneNumber, code, deviceId)
|
||||||
|
.onSuccess { response ->
|
||||||
|
tokenManager.saveTokens(response.access_token, response.refresh_token)
|
||||||
|
}
|
||||||
|
.map { it.user }
|
||||||
|
}
|
||||||
|
|
||||||
|
suspend fun refreshTokens(): Result<Pair<String, String>> {
|
||||||
|
val refreshToken = tokenManager.getRefreshToken()
|
||||||
|
?: return Result.failure(Exception("No refresh token"))
|
||||||
|
|
||||||
|
return apiClient.refreshToken(refreshToken)
|
||||||
|
.onSuccess { response ->
|
||||||
|
tokenManager.saveTokens(response.access_token, response.refresh_token)
|
||||||
|
}
|
||||||
|
.map { it.access_token to it.refresh_token }
|
||||||
|
}
|
||||||
|
|
||||||
|
fun getAccessToken(): String? = tokenManager.getAccessToken()
|
||||||
|
|
||||||
|
suspend fun logout() {
|
||||||
|
tokenManager.getRefreshToken()?.let { refreshToken ->
|
||||||
|
apiClient.logout(refreshToken)
|
||||||
|
}
|
||||||
|
tokenManager.clearTokens()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun getDeviceId(): String {
|
||||||
|
// Use Android ID or Installation ID
|
||||||
|
return Settings.Secure.getString(
|
||||||
|
context.contentResolver,
|
||||||
|
Settings.Secure.ANDROID_ID
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Usage in Activity/Fragment
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
class LoginActivity : AppCompatActivity() {
|
||||||
|
private val authManager by lazy {
|
||||||
|
val apiClient = AuthApiClient("http://your-api-url")
|
||||||
|
val tokenManager = TokenManager(this)
|
||||||
|
AuthManager(apiClient, tokenManager)
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun requestOtp() {
|
||||||
|
lifecycleScope.launch {
|
||||||
|
val phoneNumber = phoneInput.text.toString()
|
||||||
|
authManager.requestOtp(phoneNumber)
|
||||||
|
.onSuccess { showToast("OTP sent!") }
|
||||||
|
.onFailure { showError(it.message) }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun verifyOtp() {
|
||||||
|
lifecycleScope.launch {
|
||||||
|
val phoneNumber = phoneInput.text.toString()
|
||||||
|
val code = otpInput.text.toString()
|
||||||
|
|
||||||
|
authManager.login(phoneNumber, code)
|
||||||
|
.onSuccess { user ->
|
||||||
|
if (user.needs_profile) {
|
||||||
|
startActivity(Intent(this, ProfileSetupActivity::class.java))
|
||||||
|
} else {
|
||||||
|
startActivity(Intent(this, MainActivity::class.java))
|
||||||
|
}
|
||||||
|
finish()
|
||||||
|
}
|
||||||
|
.onFailure { showError("Invalid OTP") }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Error Handling
|
||||||
|
|
||||||
|
### Common Error Codes
|
||||||
|
|
||||||
|
| Status | Error | Description |
|
||||||
|
|--------|-------|-------------|
|
||||||
|
| 400 | `phone_number is required` | Missing phone number |
|
||||||
|
| 400 | `Invalid or expired OTP` | Wrong code or OTP expired (10 min) |
|
||||||
|
| 401 | `Invalid refresh token` | Token expired or revoked |
|
||||||
|
| 401 | `Missing Authorization header` | Access token not provided |
|
||||||
|
| 403 | `Origin not allowed` | CORS restriction (production) |
|
||||||
|
| 500 | `Internal server error` | Server issue |
|
||||||
|
|
||||||
|
### Error Response Format
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"error": "Error message here"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Security Best Practices
|
||||||
|
|
||||||
|
1. **Store tokens securely** - Use `EncryptedSharedPreferences` (Android) or Keychain (iOS)
|
||||||
|
2. **Handle token expiration** - Automatically refresh when access token expires (401)
|
||||||
|
3. **Rotate refresh tokens** - Always save the new `refresh_token` after refresh
|
||||||
|
4. **Validate device_id** - Use consistent device identifier (Android ID, Installation ID)
|
||||||
|
5. **Handle reuse detection** - If refresh returns 401, force re-login (token compromised)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Token Expiration
|
||||||
|
|
||||||
|
- **Access Token:** 15 minutes (default, configurable via `JWT_ACCESS_TTL`)
|
||||||
|
- **Refresh Token:** 7 days (default, configurable via `JWT_REFRESH_TTL`)
|
||||||
|
- **OTP:** 10 minutes (fixed)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Example: Auto-refresh on 401
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
suspend fun <T> callWithAuth(block: suspend (String) -> Result<T>): Result<T> {
|
||||||
|
val token = tokenManager.getAccessToken() ?: return Result.failure(Exception("Not logged in"))
|
||||||
|
|
||||||
|
return block(token).recoverCatching { error ->
|
||||||
|
if (error is HttpException && error.response.status == HttpStatusCode.Unauthorized) {
|
||||||
|
// Token expired, refresh and retry
|
||||||
|
refreshTokens()
|
||||||
|
.getOrNull()
|
||||||
|
?.let { (newAccess, _) -> block(newAccess) }
|
||||||
|
?: Result.failure(Exception("Failed to refresh token"))
|
||||||
|
} else {
|
||||||
|
Result.failure(error)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Health Check
|
||||||
|
|
||||||
|
**Endpoint:** `GET /health`
|
||||||
|
|
||||||
|
**Response (200):**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Use this to verify the service is running before attempting authentication.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
- Phone numbers must be in E.164 format (`+` prefix with country code)
|
||||||
|
- Device ID should be 4-128 alphanumeric characters, or it will be hashed
|
||||||
|
- Refresh tokens rotate on each use - always update stored token
|
||||||
|
- If `needs_profile: true`, prompt user to complete profile before accessing app
|
||||||
|
|
@ -0,0 +1,270 @@
|
||||||
|
# Device Management Implementation - Changelog
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Enhanced the auth service to properly support multi-device login with device management capabilities. **One phone number = One account**, but that account can be logged in from **multiple devices simultaneously**.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Changes Made
|
||||||
|
|
||||||
|
### 1. Enhanced Verify OTP Endpoint (`/auth/verify-otp`)
|
||||||
|
|
||||||
|
**Added:**
|
||||||
|
- New device detection logic
|
||||||
|
- Audit logging for all login attempts
|
||||||
|
- Response fields: `is_new_device`, `is_new_account`, `active_devices_count`
|
||||||
|
|
||||||
|
**Response now includes:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"user": { ... },
|
||||||
|
"access_token": "...",
|
||||||
|
"refresh_token": "...",
|
||||||
|
"needs_profile": true,
|
||||||
|
"is_new_device": false, // NEW
|
||||||
|
"is_new_account": false, // NEW
|
||||||
|
"active_devices_count": 2 // NEW
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Benefits:**
|
||||||
|
- Mobile app can show security notifications for new devices
|
||||||
|
- Track account creation vs. existing account login
|
||||||
|
- Display active device count in UI
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Enhanced Refresh Token Endpoint (`/auth/refresh`)
|
||||||
|
|
||||||
|
**Added:**
|
||||||
|
- Updates `user_devices.last_seen_at` on token refresh
|
||||||
|
- Tracks device activity for monitoring
|
||||||
|
|
||||||
|
**Benefits:**
|
||||||
|
- Identify active vs. inactive devices
|
||||||
|
- Better device management insights
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. New User Endpoints (`/users/me/*`)
|
||||||
|
|
||||||
|
#### GET `/users/me`
|
||||||
|
- Returns user info with `active_devices_count`
|
||||||
|
- Includes account creation date and last login time
|
||||||
|
|
||||||
|
#### GET `/users/me/devices`
|
||||||
|
- Lists all active devices for the user
|
||||||
|
- Shows device metadata (platform, model, OS, etc.)
|
||||||
|
- Includes first_seen_at and last_seen_at timestamps
|
||||||
|
|
||||||
|
#### DELETE `/users/me/devices/:device_id`
|
||||||
|
- Revokes/logs out a specific device
|
||||||
|
- Revokes all refresh tokens for that device
|
||||||
|
- Logs the action in audit table
|
||||||
|
|
||||||
|
#### POST `/users/me/logout-all-other-devices`
|
||||||
|
- Logs out all devices except the current one
|
||||||
|
- Requires `current_device_id` in header or body
|
||||||
|
- Returns count of revoked devices
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. Audit Logging
|
||||||
|
|
||||||
|
**Added comprehensive logging:**
|
||||||
|
- Login attempts (success/failure)
|
||||||
|
- Device revocations
|
||||||
|
- Logout actions
|
||||||
|
- All events logged to `auth_audit` table with metadata
|
||||||
|
|
||||||
|
**Audit fields:**
|
||||||
|
- `action`: 'login', 'device_revoked', 'logout_all_other_devices'
|
||||||
|
- `status`: 'success', 'failed'
|
||||||
|
- `device_id`: Device identifier
|
||||||
|
- `ip_address`: Client IP
|
||||||
|
- `user_agent`: Client user agent
|
||||||
|
- `meta`: JSONB with additional context (is_new_device, platform, etc.)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Database Changes
|
||||||
|
|
||||||
|
### No Schema Changes Required
|
||||||
|
- All features use existing tables:
|
||||||
|
- `users` (already has UNIQUE constraint on phone_number)
|
||||||
|
- `user_devices` (already tracks devices per user)
|
||||||
|
- `auth_audit` (already exists for logging)
|
||||||
|
- `refresh_tokens` (already tracks tokens per device)
|
||||||
|
|
||||||
|
### Existing Constraints Work Perfectly
|
||||||
|
- `phone_number UNIQUE` → One account per phone number ✅
|
||||||
|
- `(user_id, device_identifier) UNIQUE` → One device record per user-device combo ✅
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Security Improvements
|
||||||
|
|
||||||
|
### ✅ New Device Detection
|
||||||
|
- Automatically flags new device logins
|
||||||
|
- Mobile app can show security alerts
|
||||||
|
- Logged in audit table
|
||||||
|
|
||||||
|
### ✅ Device Activity Tracking
|
||||||
|
- `last_seen_at` updated on token refresh
|
||||||
|
- Helps identify abandoned devices
|
||||||
|
- Better security monitoring
|
||||||
|
|
||||||
|
### ✅ Device Management
|
||||||
|
- Users can see all active devices
|
||||||
|
- Users can revoke specific devices
|
||||||
|
- Users can logout all other devices (security feature)
|
||||||
|
|
||||||
|
### ✅ Audit Trail
|
||||||
|
- All authentication events logged
|
||||||
|
- Can track suspicious activity
|
||||||
|
- Compliance and security auditing
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## API Usage Examples
|
||||||
|
|
||||||
|
### Login from New Device
|
||||||
|
```bash
|
||||||
|
POST /auth/verify-otp
|
||||||
|
{
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"code": "123456",
|
||||||
|
"device_id": "new-device-123",
|
||||||
|
"device_info": { "platform": "android" }
|
||||||
|
}
|
||||||
|
|
||||||
|
Response:
|
||||||
|
{
|
||||||
|
"is_new_device": true,
|
||||||
|
"is_new_account": false,
|
||||||
|
"active_devices_count": 2
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### List Active Devices
|
||||||
|
```bash
|
||||||
|
GET /users/me/devices
|
||||||
|
Authorization: Bearer <access_token>
|
||||||
|
|
||||||
|
Response:
|
||||||
|
{
|
||||||
|
"devices": [
|
||||||
|
{
|
||||||
|
"device_identifier": "device-1",
|
||||||
|
"device_platform": "android",
|
||||||
|
"last_seen_at": "2024-01-15T10:30:00Z",
|
||||||
|
"is_active": true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Revoke Device
|
||||||
|
```bash
|
||||||
|
DELETE /users/me/devices/device-1
|
||||||
|
Authorization: Bearer <access_token>
|
||||||
|
|
||||||
|
Response:
|
||||||
|
{
|
||||||
|
"ok": true,
|
||||||
|
"message": "Device logged out successfully"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Mobile App Integration
|
||||||
|
|
||||||
|
### New Response Fields to Handle
|
||||||
|
|
||||||
|
1. **`is_new_device`** → Show security notification
|
||||||
|
2. **`is_new_account`** → Show welcome flow
|
||||||
|
3. **`active_devices_count`** → Display in settings
|
||||||
|
|
||||||
|
### New Endpoints to Implement
|
||||||
|
|
||||||
|
1. **Device List Screen** → Show all active devices
|
||||||
|
2. **Revoke Device** → Allow users to logout specific devices
|
||||||
|
3. **Security Settings** → Show active device count
|
||||||
|
|
||||||
|
### Example Flow
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
// After login
|
||||||
|
if (response.is_new_device && !response.is_new_account) {
|
||||||
|
showSecurityAlert("New device logged in: ${deviceModel}")
|
||||||
|
}
|
||||||
|
|
||||||
|
// In settings screen
|
||||||
|
val devices = apiClient.getDevices(accessToken)
|
||||||
|
devices.forEach { device ->
|
||||||
|
showDeviceCard(
|
||||||
|
model = device.device_model,
|
||||||
|
lastSeen = device.last_seen_at,
|
||||||
|
onRevoke = { revokeDevice(device.device_identifier) }
|
||||||
|
)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Testing Checklist
|
||||||
|
|
||||||
|
- [x] Same phone number can log in from multiple devices
|
||||||
|
- [x] Each device gets its own refresh token
|
||||||
|
- [x] Devices can be active simultaneously
|
||||||
|
- [x] Revoking one device doesn't affect others
|
||||||
|
- [x] New device detection works correctly
|
||||||
|
- [x] Audit logging captures all events
|
||||||
|
- [x] Device activity tracking works
|
||||||
|
- [x] Logout all other devices works
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Backward Compatibility
|
||||||
|
|
||||||
|
✅ **Fully backward compatible**
|
||||||
|
- All existing endpoints work as before
|
||||||
|
- New response fields are additions (optional to use)
|
||||||
|
- New endpoints are additions (don't break existing code)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Next Steps
|
||||||
|
|
||||||
|
1. **Update Mobile App**
|
||||||
|
- Handle new response fields
|
||||||
|
- Implement device management UI
|
||||||
|
- Show security notifications
|
||||||
|
|
||||||
|
2. **Monitoring**
|
||||||
|
- Query `auth_audit` for suspicious activity
|
||||||
|
- Monitor device counts per user
|
||||||
|
- Alert on unusual patterns
|
||||||
|
|
||||||
|
3. **Future Enhancements**
|
||||||
|
- Device name/labeling (let users name devices)
|
||||||
|
- Push notifications on new device login
|
||||||
|
- Device location tracking (optional)
|
||||||
|
- Session limits (max devices per user)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Files Modified
|
||||||
|
|
||||||
|
1. `src/routes/authRoutes.js` - Enhanced verify-otp and refresh endpoints
|
||||||
|
2. `src/routes/userRoutes.js` - Added device management endpoints
|
||||||
|
3. `DEVICE_MANAGEMENT.md` - New documentation
|
||||||
|
4. `CHANGELOG_DEVICE_MANAGEMENT.md` - This file
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Questions?
|
||||||
|
|
||||||
|
See `DEVICE_MANAGEMENT.md` for detailed API documentation and examples.
|
||||||
|
|
@ -0,0 +1,428 @@
|
||||||
|
# Device Management Features
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The auth service now supports proper multi-device login with device management capabilities. **One phone number = One account**, but that account can be logged in from **multiple devices simultaneously**.
|
||||||
|
|
||||||
|
## Key Features
|
||||||
|
|
||||||
|
### ✅ Multi-Device Support
|
||||||
|
- Same phone number can log in from multiple devices
|
||||||
|
- Each device gets its own refresh token
|
||||||
|
- Devices can be active simultaneously
|
||||||
|
- Independent sessions per device
|
||||||
|
|
||||||
|
### ✅ Device Tracking
|
||||||
|
- All login attempts are logged to `auth_audit` table
|
||||||
|
- New device detection flags (`is_new_device`, `is_new_account`)
|
||||||
|
- Device metadata tracking (platform, model, OS version, etc.)
|
||||||
|
|
||||||
|
### ✅ Device Management
|
||||||
|
- List all active devices
|
||||||
|
- Revoke/logout specific devices
|
||||||
|
- Logout all other devices (keep current)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Updated Endpoints
|
||||||
|
|
||||||
|
### 1. Verify OTP (Enhanced Response)
|
||||||
|
|
||||||
|
**Endpoint:** `POST /auth/verify-otp`
|
||||||
|
|
||||||
|
**Response now includes:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"user": { ... },
|
||||||
|
"access_token": "...",
|
||||||
|
"refresh_token": "...",
|
||||||
|
"needs_profile": true,
|
||||||
|
"is_new_device": false, // ← NEW: Is this a new device?
|
||||||
|
"is_new_account": false, // ← NEW: Is this a new account?
|
||||||
|
"active_devices_count": 2 // ← NEW: How many devices are active?
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Use Cases:**
|
||||||
|
- `is_new_device: true` → Show security notification to user
|
||||||
|
- `is_new_account: true` → Welcome new user flow
|
||||||
|
- `active_devices_count` → Display in settings/profile
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Get User Info
|
||||||
|
|
||||||
|
**Endpoint:** `GET /users/me`
|
||||||
|
|
||||||
|
**Headers:**
|
||||||
|
```
|
||||||
|
Authorization: Bearer <access_token>
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "uuid",
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"name": "John Doe",
|
||||||
|
"role": "user",
|
||||||
|
"user_type": "seller",
|
||||||
|
"created_at": "2024-01-01T00:00:00Z",
|
||||||
|
"last_login_at": "2024-01-15T10:30:00Z",
|
||||||
|
"active_devices_count": 2
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. List Active Devices
|
||||||
|
|
||||||
|
**Endpoint:** `GET /users/me/devices`
|
||||||
|
|
||||||
|
**Headers:**
|
||||||
|
```
|
||||||
|
Authorization: Bearer <access_token>
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"devices": [
|
||||||
|
{
|
||||||
|
"device_identifier": "android-device-123",
|
||||||
|
"device_platform": "android",
|
||||||
|
"device_model": "Samsung Galaxy S21",
|
||||||
|
"os_version": "Android 14",
|
||||||
|
"app_version": "1.0.0",
|
||||||
|
"language_code": "en-IN",
|
||||||
|
"timezone": "Asia/Kolkata",
|
||||||
|
"first_seen_at": "2024-01-10T08:00:00Z",
|
||||||
|
"last_seen_at": "2024-01-15T10:30:00Z",
|
||||||
|
"is_active": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"device_identifier": "iphone-device-456",
|
||||||
|
"device_platform": "ios",
|
||||||
|
"device_model": "iPhone 13",
|
||||||
|
"os_version": "iOS 17.2",
|
||||||
|
"app_version": "1.0.0",
|
||||||
|
"language_code": "en-IN",
|
||||||
|
"timezone": "Asia/Kolkata",
|
||||||
|
"first_seen_at": "2024-01-12T14:20:00Z",
|
||||||
|
"last_seen_at": "2024-01-15T09:15:00Z",
|
||||||
|
"is_active": true
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. Revoke Specific Device
|
||||||
|
|
||||||
|
**Endpoint:** `DELETE /users/me/devices/:device_id`
|
||||||
|
|
||||||
|
**Headers:**
|
||||||
|
```
|
||||||
|
Authorization: Bearer <access_token>
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true,
|
||||||
|
"message": "Device logged out successfully"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**What it does:**
|
||||||
|
- Marks device as inactive in `user_devices` table
|
||||||
|
- Revokes all refresh tokens for that device
|
||||||
|
- Logs the action in `auth_audit` table
|
||||||
|
|
||||||
|
**Kotlin Example:**
|
||||||
|
```kotlin
|
||||||
|
suspend fun revokeDevice(deviceId: String, accessToken: String): Result<Unit> {
|
||||||
|
val response = apiClient.delete("/users/me/devices/$deviceId") {
|
||||||
|
header("Authorization", "Bearer $accessToken")
|
||||||
|
}
|
||||||
|
return if (response.status.isSuccess()) {
|
||||||
|
Result.success(Unit)
|
||||||
|
} else {
|
||||||
|
Result.failure(Exception("Failed to revoke device"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5. Logout All Other Devices
|
||||||
|
|
||||||
|
**Endpoint:** `POST /users/me/logout-all-other-devices`
|
||||||
|
|
||||||
|
**Headers:**
|
||||||
|
```
|
||||||
|
Authorization: Bearer <access_token>
|
||||||
|
X-Device-Id: <current_device_id> // ← Required header
|
||||||
|
```
|
||||||
|
|
||||||
|
**OR Request Body:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"current_device_id": "android-device-123"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"ok": true,
|
||||||
|
"message": "Logged out 2 device(s)",
|
||||||
|
"revoked_devices_count": 2
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**What it does:**
|
||||||
|
- Keeps current device active
|
||||||
|
- Logs out all other devices
|
||||||
|
- Revokes refresh tokens for all other devices
|
||||||
|
|
||||||
|
**Kotlin Example:**
|
||||||
|
```kotlin
|
||||||
|
suspend fun logoutAllOtherDevices(
|
||||||
|
currentDeviceId: String,
|
||||||
|
accessToken: String
|
||||||
|
): Result<LogoutAllResponse> {
|
||||||
|
val response = apiClient.post("/users/me/logout-all-other-devices") {
|
||||||
|
header("Authorization", "Bearer $accessToken")
|
||||||
|
header("X-Device-Id", currentDeviceId)
|
||||||
|
contentType(ContentType.Application.Json)
|
||||||
|
setBody(JsonObject(mapOf(
|
||||||
|
"current_device_id" to JsonPrimitive(currentDeviceId)
|
||||||
|
)))
|
||||||
|
}
|
||||||
|
return Result.success(response.body())
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Authentication Flow Example
|
||||||
|
|
||||||
|
### Scenario: User logs in from new phone
|
||||||
|
|
||||||
|
1. **Request OTP** (same phone number)
|
||||||
|
```kotlin
|
||||||
|
POST /auth/request-otp
|
||||||
|
{ "phone_number": "+919876543210" }
|
||||||
|
```
|
||||||
|
|
||||||
|
2. **Verify OTP** (from new device)
|
||||||
|
```kotlin
|
||||||
|
POST /auth/verify-otp
|
||||||
|
{
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"code": "123456",
|
||||||
|
"device_id": "new-phone-device-id",
|
||||||
|
"device_info": { "platform": "android", ... }
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
3. **Response:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"user": { ... },
|
||||||
|
"access_token": "...",
|
||||||
|
"refresh_token": "...",
|
||||||
|
"is_new_device": true, // ← This is a new device
|
||||||
|
"is_new_account": false, // ← But existing account
|
||||||
|
"active_devices_count": 2 // ← Now 2 devices active
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
4. **Mobile App Action:**
|
||||||
|
- Show notification: "New device logged in: Android Phone"
|
||||||
|
- Display in security settings: "Active Devices: 2"
|
||||||
|
- Allow user to revoke old device if needed
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Security Features
|
||||||
|
|
||||||
|
### ✅ New Device Detection
|
||||||
|
- Automatically detected on login
|
||||||
|
- Logged in `auth_audit` table
|
||||||
|
- Flag returned in response for app to show alert
|
||||||
|
|
||||||
|
### ✅ Device Activity Tracking
|
||||||
|
- `last_seen_at` updated on token refresh
|
||||||
|
- Tracks when device was last active
|
||||||
|
- Helps identify abandoned/inactive devices
|
||||||
|
|
||||||
|
### ✅ Audit Logging
|
||||||
|
All authentication events logged:
|
||||||
|
- Login attempts (success/failure)
|
||||||
|
- Device revocations
|
||||||
|
- Logout actions
|
||||||
|
- Token refreshes
|
||||||
|
|
||||||
|
Query audit logs:
|
||||||
|
```sql
|
||||||
|
SELECT * FROM auth_audit
|
||||||
|
WHERE user_id = 'user-uuid'
|
||||||
|
ORDER BY created_at DESC;
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Mobile App Implementation
|
||||||
|
|
||||||
|
### Show Active Devices Screen
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
class DeviceManagementActivity : AppCompatActivity() {
|
||||||
|
private val authManager = AuthManager(...)
|
||||||
|
|
||||||
|
override fun onCreate(savedInstanceState: Bundle?) {
|
||||||
|
super.onCreate(savedInstanceState)
|
||||||
|
|
||||||
|
lifecycleScope.launch {
|
||||||
|
val devices = authManager.getActiveDevices()
|
||||||
|
devices.forEach { device ->
|
||||||
|
// Display device info
|
||||||
|
// Show "Revoke" button
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun revokeDevice(deviceId: String) {
|
||||||
|
lifecycleScope.launch {
|
||||||
|
authManager.revokeDevice(deviceId)
|
||||||
|
.onSuccess {
|
||||||
|
// Refresh device list
|
||||||
|
// Show toast: "Device logged out"
|
||||||
|
}
|
||||||
|
.onFailure { showError("Failed to revoke device") }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Handle New Device Login
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
private fun handleLoginResponse(response: VerifyOtpResponse) {
|
||||||
|
if (response.is_new_device && !response.is_new_account) {
|
||||||
|
// Show security alert
|
||||||
|
showDialog(
|
||||||
|
title = "New Device Detected",
|
||||||
|
message = "You've logged in from a new device. " +
|
||||||
|
"If this wasn't you, please change your password.",
|
||||||
|
positiveButton = "OK"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Save tokens
|
||||||
|
tokenManager.saveTokens(response.access_token, response.refresh_token)
|
||||||
|
|
||||||
|
// Navigate to home/profile
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Database Schema
|
||||||
|
|
||||||
|
### user_devices Table
|
||||||
|
```sql
|
||||||
|
CREATE TABLE user_devices (
|
||||||
|
id UUID PRIMARY KEY,
|
||||||
|
user_id UUID NOT NULL REFERENCES users(id),
|
||||||
|
device_identifier TEXT,
|
||||||
|
device_platform TEXT NOT NULL,
|
||||||
|
device_model TEXT,
|
||||||
|
os_version TEXT,
|
||||||
|
app_version TEXT,
|
||||||
|
language_code TEXT,
|
||||||
|
timezone TEXT,
|
||||||
|
first_seen_at TIMESTAMPTZ NOT NULL,
|
||||||
|
last_seen_at TIMESTAMPTZ,
|
||||||
|
is_active BOOLEAN NOT NULL DEFAULT TRUE,
|
||||||
|
UNIQUE (user_id, device_identifier)
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
### auth_audit Table
|
||||||
|
```sql
|
||||||
|
CREATE TABLE auth_audit (
|
||||||
|
id UUID PRIMARY KEY,
|
||||||
|
user_id UUID REFERENCES users(id),
|
||||||
|
action VARCHAR(100) NOT NULL, -- 'login', 'device_revoked', etc.
|
||||||
|
status VARCHAR(50) NOT NULL, -- 'success', 'failed'
|
||||||
|
device_id VARCHAR(255),
|
||||||
|
ip_address VARCHAR(45),
|
||||||
|
user_agent TEXT,
|
||||||
|
meta JSONB,
|
||||||
|
created_at TIMESTAMPTZ NOT NULL
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Important Notes
|
||||||
|
|
||||||
|
1. **Phone Number = Account Ownership**
|
||||||
|
- One phone number = One account
|
||||||
|
- If someone else uses your phone number, they access your account
|
||||||
|
- Always protect your phone number/SIM card
|
||||||
|
|
||||||
|
2. **Multiple Devices = Same Account**
|
||||||
|
- All devices access the same user account
|
||||||
|
- Data is shared across devices
|
||||||
|
- Logout on one device doesn't affect others
|
||||||
|
|
||||||
|
3. **Device ID Must Be Consistent**
|
||||||
|
- Use same `device_id` for same physical device
|
||||||
|
- Don't randomly generate new IDs
|
||||||
|
- Use Android ID, Installation ID, or Firebase Installation ID
|
||||||
|
|
||||||
|
4. **Token Rotation**
|
||||||
|
- Refresh tokens rotate on each refresh
|
||||||
|
- Always save the new `refresh_token`
|
||||||
|
- Old tokens become invalid
|
||||||
|
|
||||||
|
5. **Device Revocation**
|
||||||
|
- Revoking a device logs it out immediately
|
||||||
|
- Refresh tokens for that device are revoked
|
||||||
|
- User must re-login on that device
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
|
### Test Multi-Device Login
|
||||||
|
```bash
|
||||||
|
# Device 1
|
||||||
|
curl -X POST http://localhost:3000/auth/verify-otp \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"code": "123456",
|
||||||
|
"device_id": "device-1"
|
||||||
|
}'
|
||||||
|
|
||||||
|
# Device 2 (same phone, different device)
|
||||||
|
curl -X POST http://localhost:3000/auth/verify-otp \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"code": "123456",
|
||||||
|
"device_id": "device-2"
|
||||||
|
}'
|
||||||
|
|
||||||
|
# Check active devices
|
||||||
|
curl -X GET http://localhost:3000/users/me/devices \
|
||||||
|
-H "Authorization: Bearer <access_token>"
|
||||||
|
```
|
||||||
|
|
||||||
|
Both devices should be logged in and visible in the devices list.
|
||||||
|
|
@ -0,0 +1,348 @@
|
||||||
|
# Farm Auth Service - Quick Start
|
||||||
|
|
||||||
|
## Base URL
|
||||||
|
```
|
||||||
|
Development: http://localhost:3000
|
||||||
|
Production: https://your-domain.com
|
||||||
|
```
|
||||||
|
|
||||||
|
## Authentication Flow
|
||||||
|
|
||||||
|
```
|
||||||
|
1. POST /auth/request-otp → User enters phone number
|
||||||
|
2. POST /auth/verify-otp → User enters OTP code → Get tokens
|
||||||
|
3. Use access_token in header → Authorization: Bearer <token>
|
||||||
|
4. POST /auth/refresh → Get new tokens when expired
|
||||||
|
5. POST /auth/logout → Revoke token
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Endpoints
|
||||||
|
|
||||||
|
### 1. Request OTP
|
||||||
|
```http
|
||||||
|
POST /auth/request-otp
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"phone_number": "+919876543210"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{ "ok": true }
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 2. Verify OTP (Login)
|
||||||
|
```http
|
||||||
|
POST /auth/verify-otp
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"code": "123456",
|
||||||
|
"device_id": "android-device-id-123",
|
||||||
|
"device_info": {
|
||||||
|
"platform": "android",
|
||||||
|
"model": "Samsung Galaxy",
|
||||||
|
"os_version": "Android 14",
|
||||||
|
"app_version": "1.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"user": {
|
||||||
|
"id": "uuid",
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"name": null,
|
||||||
|
"role": "user",
|
||||||
|
"user_type": null
|
||||||
|
},
|
||||||
|
"access_token": "eyJhbGc...",
|
||||||
|
"refresh_token": "eyJhbGc...",
|
||||||
|
"needs_profile": true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Store:** `access_token` and `refresh_token` securely (EncryptedSharedPreferences)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 3. Refresh Token
|
||||||
|
```http
|
||||||
|
POST /auth/refresh
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"refresh_token": "eyJhbGc..."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"access_token": "eyJhbGc...",
|
||||||
|
"refresh_token": "eyJhbGc..." ← Always save this new token!
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Important:** Refresh tokens rotate. Always save the new `refresh_token`.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 4. Update Profile
|
||||||
|
```http
|
||||||
|
PUT /users/me
|
||||||
|
Authorization: Bearer <access_token>
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"name": "John Doe",
|
||||||
|
"user_type": "seller" // or "buyer" or "service_provider"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "uuid",
|
||||||
|
"phone_number": "+919876543210",
|
||||||
|
"name": "John Doe",
|
||||||
|
"role": "user",
|
||||||
|
"user_type": "seller"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 5. Logout
|
||||||
|
```http
|
||||||
|
POST /auth/logout
|
||||||
|
Content-Type: application/json
|
||||||
|
|
||||||
|
{
|
||||||
|
"refresh_token": "eyJhbGc..."
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Response:**
|
||||||
|
```json
|
||||||
|
{ "ok": true }
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Kotlin Data Classes
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
// Request Models
|
||||||
|
data class RequestOtpRequest(val phone_number: String)
|
||||||
|
|
||||||
|
data class VerifyOtpRequest(
|
||||||
|
val phone_number: String,
|
||||||
|
val code: String,
|
||||||
|
val device_id: String,
|
||||||
|
val device_info: DeviceInfo? = null
|
||||||
|
)
|
||||||
|
|
||||||
|
data class DeviceInfo(
|
||||||
|
val platform: String = "android",
|
||||||
|
val model: String? = null,
|
||||||
|
val os_version: String? = null,
|
||||||
|
val app_version: String? = null,
|
||||||
|
val language_code: String? = null,
|
||||||
|
val timezone: String? = null
|
||||||
|
)
|
||||||
|
|
||||||
|
data class RefreshRequest(val refresh_token: String)
|
||||||
|
|
||||||
|
data class UpdateProfileRequest(
|
||||||
|
val name: String,
|
||||||
|
val user_type: String // "seller" | "buyer" | "service_provider"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Response Models
|
||||||
|
data class User(
|
||||||
|
val id: String,
|
||||||
|
val phone_number: String,
|
||||||
|
val name: String?,
|
||||||
|
val role: String,
|
||||||
|
val user_type: String?
|
||||||
|
)
|
||||||
|
|
||||||
|
data class VerifyOtpResponse(
|
||||||
|
val user: User,
|
||||||
|
val access_token: String,
|
||||||
|
val refresh_token: String,
|
||||||
|
val needs_profile: Boolean
|
||||||
|
)
|
||||||
|
|
||||||
|
data class RefreshResponse(
|
||||||
|
val access_token: String,
|
||||||
|
val refresh_token: String
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Example: Kotlin HTTP Client
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
// Using Retrofit + OkHttp
|
||||||
|
interface AuthApi {
|
||||||
|
@POST("auth/request-otp")
|
||||||
|
suspend fun requestOtp(@Body request: RequestOtpRequest): Response<Unit>
|
||||||
|
|
||||||
|
@POST("auth/verify-otp")
|
||||||
|
suspend fun verifyOtp(@Body request: VerifyOtpRequest): Response<VerifyOtpResponse>
|
||||||
|
|
||||||
|
@POST("auth/refresh")
|
||||||
|
suspend fun refreshToken(@Body request: RefreshRequest): Response<RefreshResponse>
|
||||||
|
|
||||||
|
@PUT("users/me")
|
||||||
|
suspend fun updateProfile(
|
||||||
|
@Header("Authorization") token: String,
|
||||||
|
@Body request: UpdateProfileRequest
|
||||||
|
): Response<User>
|
||||||
|
|
||||||
|
@POST("auth/logout")
|
||||||
|
suspend fun logout(@Body request: RefreshRequest): Response<Unit>
|
||||||
|
}
|
||||||
|
|
||||||
|
// Usage
|
||||||
|
val api = Retrofit.Builder()
|
||||||
|
.baseUrl("http://your-api-url")
|
||||||
|
.addConverterFactory(GsonConverterFactory.create())
|
||||||
|
.build()
|
||||||
|
.create(AuthApi::class.java)
|
||||||
|
|
||||||
|
// Request OTP
|
||||||
|
api.requestOtp(RequestOtpRequest("+919876543210"))
|
||||||
|
|
||||||
|
// Verify OTP
|
||||||
|
val response = api.verifyOtp(
|
||||||
|
VerifyOtpRequest(
|
||||||
|
phone_number = "+919876543210",
|
||||||
|
code = "123456",
|
||||||
|
device_id = getDeviceId(),
|
||||||
|
device_info = DeviceInfo(platform = "android")
|
||||||
|
)
|
||||||
|
)
|
||||||
|
val tokens = response.body() // Save access_token & refresh_token
|
||||||
|
|
||||||
|
// Make authenticated request
|
||||||
|
val user = api.updateProfile(
|
||||||
|
"Bearer ${accessToken}",
|
||||||
|
UpdateProfileRequest("John", "seller")
|
||||||
|
)
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Error Codes
|
||||||
|
|
||||||
|
| Code | Error | Solution |
|
||||||
|
|------|-------|----------|
|
||||||
|
| 400 | `phone_number is required` | Include phone_number in request |
|
||||||
|
| 400 | `Invalid or expired OTP` | Re-request OTP (expires in 10 min) |
|
||||||
|
| 401 | `Invalid refresh token` | Force re-login |
|
||||||
|
| 401 | `Missing Authorization header` | Include `Authorization: Bearer <token>` |
|
||||||
|
| 403 | `Origin not allowed` | CORS issue (production) |
|
||||||
|
| 500 | `Internal server error` | Retry later |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Token Storage (Android)
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
// Use EncryptedSharedPreferences
|
||||||
|
import androidx.security.crypto.EncryptedSharedPreferences
|
||||||
|
import androidx.security.crypto.MasterKey
|
||||||
|
|
||||||
|
class TokenStorage(context: Context) {
|
||||||
|
private val prefs = EncryptedSharedPreferences.create(
|
||||||
|
context,
|
||||||
|
"auth_tokens",
|
||||||
|
MasterKey.Builder(context).setKeyScheme(MasterKey.KeyScheme.AES256_GCM).build(),
|
||||||
|
EncryptedSharedPreferences.PrefKeyEncryptionScheme.AES256_SIV,
|
||||||
|
EncryptedSharedPreferences.PrefValueEncryptionScheme.AES256_GCM
|
||||||
|
)
|
||||||
|
|
||||||
|
fun saveTokens(access: String, refresh: String) {
|
||||||
|
prefs.edit().apply {
|
||||||
|
putString("access_token", access)
|
||||||
|
putString("refresh_token", refresh)
|
||||||
|
apply()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fun getAccessToken() = prefs.getString("access_token", null)
|
||||||
|
fun getRefreshToken() = prefs.getString("refresh_token", null)
|
||||||
|
fun clear() = prefs.edit().clear().apply()
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Token Expiration
|
||||||
|
|
||||||
|
- **Access Token:** 15 minutes (auto-refresh on 401)
|
||||||
|
- **Refresh Token:** 7 days
|
||||||
|
- **OTP:** 10 minutes
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Phone Number Format
|
||||||
|
|
||||||
|
- `9876543210` → Auto-converted to `+919876543210` (10-digit = India)
|
||||||
|
- `+919876543210` → Used as-is
|
||||||
|
- Always send in E.164 format: `+<country_code><number>`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Device ID
|
||||||
|
|
||||||
|
- Must be 4-128 alphanumeric characters
|
||||||
|
- Use: Android ID, Installation ID, or Firebase Installation ID
|
||||||
|
- Invalid formats are auto-hashed
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Security Notes
|
||||||
|
|
||||||
|
1. ✅ Store tokens in EncryptedSharedPreferences
|
||||||
|
2. ✅ Auto-refresh access token on 401 errors
|
||||||
|
3. ✅ Always save new refresh_token after refresh (tokens rotate)
|
||||||
|
4. ✅ Logout clears tokens and revokes refresh token
|
||||||
|
5. ⚠️ If refresh returns 401 → Force re-login (token compromised/reused)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Full Example Flow
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
// 1. Request OTP
|
||||||
|
api.requestOtp(RequestOtpRequest("+919876543210"))
|
||||||
|
|
||||||
|
// 2. Verify OTP & Save Tokens
|
||||||
|
val loginResponse = api.verifyOtp(...)
|
||||||
|
tokenStorage.saveTokens(loginResponse.access_token, loginResponse.refresh_token)
|
||||||
|
|
||||||
|
// 3. Use Access Token
|
||||||
|
val user = api.updateProfile("Bearer ${tokenStorage.getAccessToken()}", ...)
|
||||||
|
|
||||||
|
// 4. Handle Token Expiration (401) → Refresh
|
||||||
|
val refreshResponse = api.refreshToken(RefreshRequest(tokenStorage.getRefreshToken()!!))
|
||||||
|
tokenStorage.saveTokens(refreshResponse.access_token, refreshResponse.refresh_token)
|
||||||
|
|
||||||
|
// 5. Logout
|
||||||
|
api.logout(RefreshRequest(tokenStorage.getRefreshToken()!!))
|
||||||
|
tokenStorage.clear()
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,299 @@
|
||||||
|
# Phone Number & Device Management - Security Scenarios
|
||||||
|
|
||||||
|
## Current System Behavior
|
||||||
|
|
||||||
|
### Scenario 1: Two Different Users with Same Phone Number
|
||||||
|
|
||||||
|
**Current Behavior:**
|
||||||
|
- ❌ **SECURITY ISSUE**: Both users will access the **SAME account**
|
||||||
|
- The system uses "find or create" logic:
|
||||||
|
- If phone number exists → Logs into existing account
|
||||||
|
- If phone number doesn't exist → Creates new account
|
||||||
|
- The second person can:
|
||||||
|
- See the first person's data
|
||||||
|
- Modify the first person's profile
|
||||||
|
- Access their listings/transactions
|
||||||
|
- Change their account settings
|
||||||
|
|
||||||
|
**Why this happens:**
|
||||||
|
```javascript
|
||||||
|
// src/routes/authRoutes.js (lines 88-107)
|
||||||
|
// find or create user
|
||||||
|
const found = await db.query(`SELECT ... FROM users WHERE phone_number = $1`, [phone]);
|
||||||
|
if (found.rows.length === 0) {
|
||||||
|
// Create new user
|
||||||
|
} else {
|
||||||
|
user = found.rows[0]; // ← Uses existing account!
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Database Constraint:**
|
||||||
|
- `phone_number` has UNIQUE constraint (one account per phone number)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### Scenario 2: Same User, Different Device
|
||||||
|
|
||||||
|
**Current Behavior:**
|
||||||
|
- ✅ **Works correctly**: Same user can log in from multiple devices
|
||||||
|
- Each device gets:
|
||||||
|
- Its own refresh token (tracked by `device_id`)
|
||||||
|
- Separate device record in `user_devices` table
|
||||||
|
- Independent session
|
||||||
|
- All devices can be logged in **simultaneously**
|
||||||
|
- Each device's tokens work independently
|
||||||
|
|
||||||
|
**How it works:**
|
||||||
|
```javascript
|
||||||
|
// Device tracking (lines 117-142)
|
||||||
|
INSERT INTO user_devices (user_id, device_identifier, ...)
|
||||||
|
VALUES ($1, $2, ...)
|
||||||
|
ON CONFLICT (user_id, device_identifier)
|
||||||
|
DO UPDATE SET last_seen_at = NOW(), ...
|
||||||
|
```
|
||||||
|
|
||||||
|
**Database Constraint:**
|
||||||
|
- `UNIQUE (user_id, device_identifier)` → Same device can't be registered twice for same user
|
||||||
|
|
||||||
|
**Example:**
|
||||||
|
1. User logs in on Phone A → Gets tokens, device_id = "phone-a"
|
||||||
|
2. User logs in on Phone B → Gets different tokens, device_id = "phone-b"
|
||||||
|
3. Both devices active simultaneously
|
||||||
|
4. Logout on Phone A → Only revokes tokens for device_id = "phone-a"
|
||||||
|
5. Phone B continues working
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Security Risks
|
||||||
|
|
||||||
|
### Risk 1: Phone Number Hijacking
|
||||||
|
|
||||||
|
**Problem:**
|
||||||
|
- If someone gets access to your phone number (SIM swap, lost phone), they can log into your account
|
||||||
|
- They receive the OTP and gain full account access
|
||||||
|
|
||||||
|
**Mitigation (Recommended):**
|
||||||
|
1. Add additional verification (email, recovery questions)
|
||||||
|
2. Implement device fingerprinting
|
||||||
|
3. Alert user on new device login
|
||||||
|
4. Allow user to see all active devices and revoke them
|
||||||
|
|
||||||
|
### Risk 2: Shared Phone Numbers
|
||||||
|
|
||||||
|
**Problem:**
|
||||||
|
- Family members sharing a phone
|
||||||
|
- Business phone used by multiple employees
|
||||||
|
- Second-hand phone numbers
|
||||||
|
|
||||||
|
**Current Impact:**
|
||||||
|
- Account confusion
|
||||||
|
- Data privacy violations
|
||||||
|
- Unauthorized access
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Recommended Solutions
|
||||||
|
|
||||||
|
### Solution 1: Warn User on First Login from New Device
|
||||||
|
|
||||||
|
**Implementation:**
|
||||||
|
```javascript
|
||||||
|
// In verify-otp endpoint
|
||||||
|
const existingDevices = await db.query(
|
||||||
|
`SELECT COUNT(*) FROM user_devices WHERE user_id = $1`,
|
||||||
|
[user.id]
|
||||||
|
);
|
||||||
|
|
||||||
|
if (existingDevices.rows[0].count > 0) {
|
||||||
|
// This is a new device for existing account
|
||||||
|
// Could send notification to all other devices
|
||||||
|
// Or require additional verification
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Solution 2: Multi-Factor Authentication (MFA)
|
||||||
|
|
||||||
|
**Add options:**
|
||||||
|
- Email verification for new device
|
||||||
|
- SMS backup codes
|
||||||
|
- Recovery questions
|
||||||
|
- Authenticator app
|
||||||
|
|
||||||
|
### Solution 3: Account Ownership Verification
|
||||||
|
|
||||||
|
**Before creating account:**
|
||||||
|
```javascript
|
||||||
|
// Check if phone number recently used
|
||||||
|
const recentLogins = await db.query(
|
||||||
|
`SELECT user_id, last_login_at
|
||||||
|
FROM users
|
||||||
|
WHERE phone_number = $1
|
||||||
|
AND last_login_at > NOW() - INTERVAL '7 days'`,
|
||||||
|
[phoneNumber]
|
||||||
|
);
|
||||||
|
|
||||||
|
if (recentLogins.rows.length > 0) {
|
||||||
|
// Require additional verification or block
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Solution 4: Device Management Endpoint
|
||||||
|
|
||||||
|
**Add API endpoints:**
|
||||||
|
```javascript
|
||||||
|
// GET /users/me/devices - List all active devices
|
||||||
|
// DELETE /users/me/devices/:device_id - Revoke specific device
|
||||||
|
// POST /users/me/devices/:device_id/verify - Verify device ownership
|
||||||
|
```
|
||||||
|
|
||||||
|
### Solution 5: Session Limits
|
||||||
|
|
||||||
|
**Limit concurrent sessions:**
|
||||||
|
```javascript
|
||||||
|
// Enforce maximum devices per user
|
||||||
|
const MAX_DEVICES = 5;
|
||||||
|
const deviceCount = await db.query(
|
||||||
|
`SELECT COUNT(*) FROM user_devices WHERE user_id = $1 AND is_active = true`,
|
||||||
|
[user.id]
|
||||||
|
);
|
||||||
|
|
||||||
|
if (deviceCount >= MAX_DEVICES) {
|
||||||
|
// Revoke oldest device or require user to choose which to revoke
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Immediate Actions Needed
|
||||||
|
|
||||||
|
### 1. Document Current Behavior
|
||||||
|
- Update API documentation
|
||||||
|
- Warn developers about phone number uniqueness
|
||||||
|
- Add to user terms of service
|
||||||
|
|
||||||
|
### 2. Add Logging
|
||||||
|
```javascript
|
||||||
|
// Log all login attempts
|
||||||
|
await db.query(
|
||||||
|
`INSERT INTO auth_audit (user_id, action, status, device_id, ip_address)
|
||||||
|
VALUES ($1, 'login', 'success', $2, $3)`,
|
||||||
|
[user.id, devId, req.ip]
|
||||||
|
);
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Add User Notifications
|
||||||
|
- Email/SMS alert when login from new device
|
||||||
|
- Show active devices in user profile
|
||||||
|
- Allow device revocation
|
||||||
|
|
||||||
|
### 4. Consider Account Recovery Flow
|
||||||
|
- Allow users to dispute account ownership
|
||||||
|
- Support team can transfer ownership
|
||||||
|
- Require additional verification for sensitive actions
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Testing Scenarios
|
||||||
|
|
||||||
|
### Test Case 1: Same Phone, Different Users
|
||||||
|
```
|
||||||
|
1. User A requests OTP for +919876543210
|
||||||
|
2. User A verifies OTP → Account created
|
||||||
|
3. User B requests OTP for +919876543210
|
||||||
|
4. User B verifies OTP → Logs into User A's account ❌
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test Case 2: Same User, Multiple Devices
|
||||||
|
```
|
||||||
|
1. User logs in on Device A → Gets tokens
|
||||||
|
2. User logs in on Device B → Gets different tokens
|
||||||
|
3. Both tokens work simultaneously ✅
|
||||||
|
4. User logs out on Device A → Device B still works ✅
|
||||||
|
```
|
||||||
|
|
||||||
|
### Test Case 3: Device Re-login
|
||||||
|
```
|
||||||
|
1. User logs in on Device A
|
||||||
|
2. User logs out
|
||||||
|
3. User logs in again on Device A → New tokens issued ✅
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Best Practices for Mobile App
|
||||||
|
|
||||||
|
### 1. Inform Users
|
||||||
|
```kotlin
|
||||||
|
// Show warning in app
|
||||||
|
if (response.needs_profile && existingAccount) {
|
||||||
|
showDialog("This phone number is already registered.
|
||||||
|
You will be logged into the existing account.")
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Show Active Devices
|
||||||
|
```kotlin
|
||||||
|
// Display all logged-in devices
|
||||||
|
GET /users/me/devices → List devices with last_seen_at
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Allow Device Management
|
||||||
|
```kotlin
|
||||||
|
// Let users revoke devices
|
||||||
|
DELETE /users/me/devices/{device_id}
|
||||||
|
```
|
||||||
|
|
||||||
|
### 4. Handle Token Revocation
|
||||||
|
```kotlin
|
||||||
|
// If refresh returns 401, check if device was revoked
|
||||||
|
if (error.code == 401) {
|
||||||
|
checkActiveDevices()
|
||||||
|
if (currentDeviceRevoked) {
|
||||||
|
forceReLogin()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Database Queries for Analysis
|
||||||
|
|
||||||
|
### Check accounts by phone
|
||||||
|
```sql
|
||||||
|
SELECT phone_number, COUNT(*) as account_count
|
||||||
|
FROM users
|
||||||
|
GROUP BY phone_number
|
||||||
|
HAVING COUNT(*) > 1;
|
||||||
|
-- Should return 0 rows (UNIQUE constraint)
|
||||||
|
```
|
||||||
|
|
||||||
|
### Check devices per user
|
||||||
|
```sql
|
||||||
|
SELECT u.phone_number, COUNT(ud.id) as device_count
|
||||||
|
FROM users u
|
||||||
|
LEFT JOIN user_devices ud ON u.id = ud.user_id
|
||||||
|
WHERE ud.is_active = true
|
||||||
|
GROUP BY u.id, u.phone_number
|
||||||
|
ORDER BY device_count DESC;
|
||||||
|
```
|
||||||
|
|
||||||
|
### Check concurrent sessions
|
||||||
|
```sql
|
||||||
|
SELECT u.phone_number, ud.device_identifier, ud.last_seen_at
|
||||||
|
FROM users u
|
||||||
|
JOIN user_devices ud ON u.id = ud.user_id
|
||||||
|
WHERE ud.is_active = true
|
||||||
|
AND ud.last_seen_at > NOW() - INTERVAL '1 hour'
|
||||||
|
ORDER BY ud.last_seen_at DESC;
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
| Scenario | Current Behavior | Risk Level | Action Needed |
|
||||||
|
|----------|-----------------|------------|---------------|
|
||||||
|
| Same phone, different users | Share same account | 🔴 HIGH | Add verification/alert |
|
||||||
|
| Same user, different devices | Multiple active sessions | 🟢 LOW | Add device management UI |
|
||||||
|
| Same device, multiple logins | Works (token refresh) | 🟢 LOW | None |
|
||||||
|
| Phone number hijacking | Full account access | 🔴 HIGH | Add MFA, alerts |
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
Subproject commit bb94b9e036cc2d44b0372a299f481f36a9afed1e
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#!/bin/sh
|
||||||
|
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||||
|
|
||||||
|
case `uname` in
|
||||||
|
*CYGWIN*|*MINGW*|*MSYS*)
|
||||||
|
if command -v cygpath > /dev/null 2>&1; then
|
||||||
|
basedir=`cygpath -w "$basedir"`
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ -x "$basedir/node" ]; then
|
||||||
|
exec "$basedir/node" "$basedir/../node-gyp-build/bin.js" "$@"
|
||||||
|
else
|
||||||
|
exec node "$basedir/../node-gyp-build/bin.js" "$@"
|
||||||
|
fi
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#!/bin/sh
|
||||||
|
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||||
|
|
||||||
|
case `uname` in
|
||||||
|
*CYGWIN*|*MINGW*|*MSYS*)
|
||||||
|
if command -v cygpath > /dev/null 2>&1; then
|
||||||
|
basedir=`cygpath -w "$basedir"`
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ -x "$basedir/node" ]; then
|
||||||
|
exec "$basedir/node" "$basedir/../node-gyp-build/optional.js" "$@"
|
||||||
|
else
|
||||||
|
exec node "$basedir/../node-gyp-build/optional.js" "$@"
|
||||||
|
fi
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
@ECHO off
|
||||||
|
GOTO start
|
||||||
|
:find_dp0
|
||||||
|
SET dp0=%~dp0
|
||||||
|
EXIT /b
|
||||||
|
:start
|
||||||
|
SETLOCAL
|
||||||
|
CALL :find_dp0
|
||||||
|
|
||||||
|
IF EXIST "%dp0%\node.exe" (
|
||||||
|
SET "_prog=%dp0%\node.exe"
|
||||||
|
) ELSE (
|
||||||
|
SET "_prog=node"
|
||||||
|
SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||||
|
)
|
||||||
|
|
||||||
|
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\node-gyp-build\optional.js" %*
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
#!/usr/bin/env pwsh
|
||||||
|
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||||
|
|
||||||
|
$exe=""
|
||||||
|
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||||
|
# Fix case when both the Windows and Linux builds of Node
|
||||||
|
# are installed in the same directory
|
||||||
|
$exe=".exe"
|
||||||
|
}
|
||||||
|
$ret=0
|
||||||
|
if (Test-Path "$basedir/node$exe") {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "$basedir/node$exe" "$basedir/../node-gyp-build/optional.js" $args
|
||||||
|
} else {
|
||||||
|
& "$basedir/node$exe" "$basedir/../node-gyp-build/optional.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
} else {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "node$exe" "$basedir/../node-gyp-build/optional.js" $args
|
||||||
|
} else {
|
||||||
|
& "node$exe" "$basedir/../node-gyp-build/optional.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
}
|
||||||
|
exit $ret
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#!/bin/sh
|
||||||
|
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||||
|
|
||||||
|
case `uname` in
|
||||||
|
*CYGWIN*|*MINGW*|*MSYS*)
|
||||||
|
if command -v cygpath > /dev/null 2>&1; then
|
||||||
|
basedir=`cygpath -w "$basedir"`
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ -x "$basedir/node" ]; then
|
||||||
|
exec "$basedir/node" "$basedir/../node-gyp-build/build-test.js" "$@"
|
||||||
|
else
|
||||||
|
exec node "$basedir/../node-gyp-build/build-test.js" "$@"
|
||||||
|
fi
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
@ECHO off
|
||||||
|
GOTO start
|
||||||
|
:find_dp0
|
||||||
|
SET dp0=%~dp0
|
||||||
|
EXIT /b
|
||||||
|
:start
|
||||||
|
SETLOCAL
|
||||||
|
CALL :find_dp0
|
||||||
|
|
||||||
|
IF EXIST "%dp0%\node.exe" (
|
||||||
|
SET "_prog=%dp0%\node.exe"
|
||||||
|
) ELSE (
|
||||||
|
SET "_prog=node"
|
||||||
|
SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||||
|
)
|
||||||
|
|
||||||
|
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\node-gyp-build\build-test.js" %*
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
#!/usr/bin/env pwsh
|
||||||
|
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||||
|
|
||||||
|
$exe=""
|
||||||
|
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||||
|
# Fix case when both the Windows and Linux builds of Node
|
||||||
|
# are installed in the same directory
|
||||||
|
$exe=".exe"
|
||||||
|
}
|
||||||
|
$ret=0
|
||||||
|
if (Test-Path "$basedir/node$exe") {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "$basedir/node$exe" "$basedir/../node-gyp-build/build-test.js" $args
|
||||||
|
} else {
|
||||||
|
& "$basedir/node$exe" "$basedir/../node-gyp-build/build-test.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
} else {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "node$exe" "$basedir/../node-gyp-build/build-test.js" $args
|
||||||
|
} else {
|
||||||
|
& "node$exe" "$basedir/../node-gyp-build/build-test.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
}
|
||||||
|
exit $ret
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
@ECHO off
|
||||||
|
GOTO start
|
||||||
|
:find_dp0
|
||||||
|
SET dp0=%~dp0
|
||||||
|
EXIT /b
|
||||||
|
:start
|
||||||
|
SETLOCAL
|
||||||
|
CALL :find_dp0
|
||||||
|
|
||||||
|
IF EXIST "%dp0%\node.exe" (
|
||||||
|
SET "_prog=%dp0%\node.exe"
|
||||||
|
) ELSE (
|
||||||
|
SET "_prog=node"
|
||||||
|
SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||||
|
)
|
||||||
|
|
||||||
|
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\node-gyp-build\bin.js" %*
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
#!/usr/bin/env pwsh
|
||||||
|
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||||
|
|
||||||
|
$exe=""
|
||||||
|
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||||
|
# Fix case when both the Windows and Linux builds of Node
|
||||||
|
# are installed in the same directory
|
||||||
|
$exe=".exe"
|
||||||
|
}
|
||||||
|
$ret=0
|
||||||
|
if (Test-Path "$basedir/node$exe") {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "$basedir/node$exe" "$basedir/../node-gyp-build/bin.js" $args
|
||||||
|
} else {
|
||||||
|
& "$basedir/node$exe" "$basedir/../node-gyp-build/bin.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
} else {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "node$exe" "$basedir/../node-gyp-build/bin.js" $args
|
||||||
|
} else {
|
||||||
|
& "node$exe" "$basedir/../node-gyp-build/bin.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
}
|
||||||
|
exit $ret
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#!/bin/sh
|
||||||
|
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||||
|
|
||||||
|
case `uname` in
|
||||||
|
*CYGWIN*|*MINGW*|*MSYS*)
|
||||||
|
if command -v cygpath > /dev/null 2>&1; then
|
||||||
|
basedir=`cygpath -w "$basedir"`
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ -x "$basedir/node" ]; then
|
||||||
|
exec "$basedir/node" "$basedir/../nodemon/bin/nodemon.js" "$@"
|
||||||
|
else
|
||||||
|
exec node "$basedir/../nodemon/bin/nodemon.js" "$@"
|
||||||
|
fi
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
@ECHO off
|
||||||
|
GOTO start
|
||||||
|
:find_dp0
|
||||||
|
SET dp0=%~dp0
|
||||||
|
EXIT /b
|
||||||
|
:start
|
||||||
|
SETLOCAL
|
||||||
|
CALL :find_dp0
|
||||||
|
|
||||||
|
IF EXIST "%dp0%\node.exe" (
|
||||||
|
SET "_prog=%dp0%\node.exe"
|
||||||
|
) ELSE (
|
||||||
|
SET "_prog=node"
|
||||||
|
SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||||
|
)
|
||||||
|
|
||||||
|
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\nodemon\bin\nodemon.js" %*
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
#!/usr/bin/env pwsh
|
||||||
|
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||||
|
|
||||||
|
$exe=""
|
||||||
|
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||||
|
# Fix case when both the Windows and Linux builds of Node
|
||||||
|
# are installed in the same directory
|
||||||
|
$exe=".exe"
|
||||||
|
}
|
||||||
|
$ret=0
|
||||||
|
if (Test-Path "$basedir/node$exe") {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "$basedir/node$exe" "$basedir/../nodemon/bin/nodemon.js" $args
|
||||||
|
} else {
|
||||||
|
& "$basedir/node$exe" "$basedir/../nodemon/bin/nodemon.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
} else {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "node$exe" "$basedir/../nodemon/bin/nodemon.js" $args
|
||||||
|
} else {
|
||||||
|
& "node$exe" "$basedir/../nodemon/bin/nodemon.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
}
|
||||||
|
exit $ret
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#!/bin/sh
|
||||||
|
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||||
|
|
||||||
|
case `uname` in
|
||||||
|
*CYGWIN*|*MINGW*|*MSYS*)
|
||||||
|
if command -v cygpath > /dev/null 2>&1; then
|
||||||
|
basedir=`cygpath -w "$basedir"`
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ -x "$basedir/node" ]; then
|
||||||
|
exec "$basedir/node" "$basedir/../touch/bin/nodetouch.js" "$@"
|
||||||
|
else
|
||||||
|
exec node "$basedir/../touch/bin/nodetouch.js" "$@"
|
||||||
|
fi
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
@ECHO off
|
||||||
|
GOTO start
|
||||||
|
:find_dp0
|
||||||
|
SET dp0=%~dp0
|
||||||
|
EXIT /b
|
||||||
|
:start
|
||||||
|
SETLOCAL
|
||||||
|
CALL :find_dp0
|
||||||
|
|
||||||
|
IF EXIST "%dp0%\node.exe" (
|
||||||
|
SET "_prog=%dp0%\node.exe"
|
||||||
|
) ELSE (
|
||||||
|
SET "_prog=node"
|
||||||
|
SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||||
|
)
|
||||||
|
|
||||||
|
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\touch\bin\nodetouch.js" %*
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
#!/usr/bin/env pwsh
|
||||||
|
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||||
|
|
||||||
|
$exe=""
|
||||||
|
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||||
|
# Fix case when both the Windows and Linux builds of Node
|
||||||
|
# are installed in the same directory
|
||||||
|
$exe=".exe"
|
||||||
|
}
|
||||||
|
$ret=0
|
||||||
|
if (Test-Path "$basedir/node$exe") {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "$basedir/node$exe" "$basedir/../touch/bin/nodetouch.js" $args
|
||||||
|
} else {
|
||||||
|
& "$basedir/node$exe" "$basedir/../touch/bin/nodetouch.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
} else {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "node$exe" "$basedir/../touch/bin/nodetouch.js" $args
|
||||||
|
} else {
|
||||||
|
& "node$exe" "$basedir/../touch/bin/nodetouch.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
}
|
||||||
|
exit $ret
|
||||||
|
|
@ -0,0 +1,16 @@
|
||||||
|
#!/bin/sh
|
||||||
|
basedir=$(dirname "$(echo "$0" | sed -e 's,\\,/,g')")
|
||||||
|
|
||||||
|
case `uname` in
|
||||||
|
*CYGWIN*|*MINGW*|*MSYS*)
|
||||||
|
if command -v cygpath > /dev/null 2>&1; then
|
||||||
|
basedir=`cygpath -w "$basedir"`
|
||||||
|
fi
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
if [ -x "$basedir/node" ]; then
|
||||||
|
exec "$basedir/node" "$basedir/../semver/bin/semver.js" "$@"
|
||||||
|
else
|
||||||
|
exec node "$basedir/../semver/bin/semver.js" "$@"
|
||||||
|
fi
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
@ECHO off
|
||||||
|
GOTO start
|
||||||
|
:find_dp0
|
||||||
|
SET dp0=%~dp0
|
||||||
|
EXIT /b
|
||||||
|
:start
|
||||||
|
SETLOCAL
|
||||||
|
CALL :find_dp0
|
||||||
|
|
||||||
|
IF EXIST "%dp0%\node.exe" (
|
||||||
|
SET "_prog=%dp0%\node.exe"
|
||||||
|
) ELSE (
|
||||||
|
SET "_prog=node"
|
||||||
|
SET PATHEXT=%PATHEXT:;.JS;=;%
|
||||||
|
)
|
||||||
|
|
||||||
|
endLocal & goto #_undefined_# 2>NUL || title %COMSPEC% & "%_prog%" "%dp0%\..\semver\bin\semver.js" %*
|
||||||
|
|
@ -0,0 +1,28 @@
|
||||||
|
#!/usr/bin/env pwsh
|
||||||
|
$basedir=Split-Path $MyInvocation.MyCommand.Definition -Parent
|
||||||
|
|
||||||
|
$exe=""
|
||||||
|
if ($PSVersionTable.PSVersion -lt "6.0" -or $IsWindows) {
|
||||||
|
# Fix case when both the Windows and Linux builds of Node
|
||||||
|
# are installed in the same directory
|
||||||
|
$exe=".exe"
|
||||||
|
}
|
||||||
|
$ret=0
|
||||||
|
if (Test-Path "$basedir/node$exe") {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "$basedir/node$exe" "$basedir/../semver/bin/semver.js" $args
|
||||||
|
} else {
|
||||||
|
& "$basedir/node$exe" "$basedir/../semver/bin/semver.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
} else {
|
||||||
|
# Support pipeline input
|
||||||
|
if ($MyInvocation.ExpectingInput) {
|
||||||
|
$input | & "node$exe" "$basedir/../semver/bin/semver.js" $args
|
||||||
|
} else {
|
||||||
|
& "node$exe" "$basedir/../semver/bin/semver.js" $args
|
||||||
|
}
|
||||||
|
$ret=$LASTEXITCODE
|
||||||
|
}
|
||||||
|
exit $ret
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,250 @@
|
||||||
|
2.0.0 / 2024-08-31
|
||||||
|
==================
|
||||||
|
|
||||||
|
* Drop node <18 support
|
||||||
|
* deps: mime-types@^3.0.0
|
||||||
|
* deps: negotiator@^1.0.0
|
||||||
|
|
||||||
|
1.3.8 / 2022-02-02
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.34
|
||||||
|
- deps: mime-db@~1.51.0
|
||||||
|
* deps: negotiator@0.6.3
|
||||||
|
|
||||||
|
1.3.7 / 2019-04-29
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: negotiator@0.6.2
|
||||||
|
- Fix sorting charset, encoding, and language with extra parameters
|
||||||
|
|
||||||
|
1.3.6 / 2019-04-28
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.24
|
||||||
|
- deps: mime-db@~1.40.0
|
||||||
|
|
||||||
|
1.3.5 / 2018-02-28
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.18
|
||||||
|
- deps: mime-db@~1.33.0
|
||||||
|
|
||||||
|
1.3.4 / 2017-08-22
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.16
|
||||||
|
- deps: mime-db@~1.29.0
|
||||||
|
|
||||||
|
1.3.3 / 2016-05-02
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.11
|
||||||
|
- deps: mime-db@~1.23.0
|
||||||
|
* deps: negotiator@0.6.1
|
||||||
|
- perf: improve `Accept` parsing speed
|
||||||
|
- perf: improve `Accept-Charset` parsing speed
|
||||||
|
- perf: improve `Accept-Encoding` parsing speed
|
||||||
|
- perf: improve `Accept-Language` parsing speed
|
||||||
|
|
||||||
|
1.3.2 / 2016-03-08
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.10
|
||||||
|
- Fix extension of `application/dash+xml`
|
||||||
|
- Update primary extension for `audio/mp4`
|
||||||
|
- deps: mime-db@~1.22.0
|
||||||
|
|
||||||
|
1.3.1 / 2016-01-19
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.9
|
||||||
|
- deps: mime-db@~1.21.0
|
||||||
|
|
||||||
|
1.3.0 / 2015-09-29
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.7
|
||||||
|
- deps: mime-db@~1.19.0
|
||||||
|
* deps: negotiator@0.6.0
|
||||||
|
- Fix including type extensions in parameters in `Accept` parsing
|
||||||
|
- Fix parsing `Accept` parameters with quoted equals
|
||||||
|
- Fix parsing `Accept` parameters with quoted semicolons
|
||||||
|
- Lazy-load modules from main entry point
|
||||||
|
- perf: delay type concatenation until needed
|
||||||
|
- perf: enable strict mode
|
||||||
|
- perf: hoist regular expressions
|
||||||
|
- perf: remove closures getting spec properties
|
||||||
|
- perf: remove a closure from media type parsing
|
||||||
|
- perf: remove property delete from media type parsing
|
||||||
|
|
||||||
|
1.2.13 / 2015-09-06
|
||||||
|
===================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.6
|
||||||
|
- deps: mime-db@~1.18.0
|
||||||
|
|
||||||
|
1.2.12 / 2015-07-30
|
||||||
|
===================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.4
|
||||||
|
- deps: mime-db@~1.16.0
|
||||||
|
|
||||||
|
1.2.11 / 2015-07-16
|
||||||
|
===================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.3
|
||||||
|
- deps: mime-db@~1.15.0
|
||||||
|
|
||||||
|
1.2.10 / 2015-07-01
|
||||||
|
===================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.2
|
||||||
|
- deps: mime-db@~1.14.0
|
||||||
|
|
||||||
|
1.2.9 / 2015-06-08
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.1
|
||||||
|
- perf: fix deopt during mapping
|
||||||
|
|
||||||
|
1.2.8 / 2015-06-07
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.1.0
|
||||||
|
- deps: mime-db@~1.13.0
|
||||||
|
* perf: avoid argument reassignment & argument slice
|
||||||
|
* perf: avoid negotiator recursive construction
|
||||||
|
* perf: enable strict mode
|
||||||
|
* perf: remove unnecessary bitwise operator
|
||||||
|
|
||||||
|
1.2.7 / 2015-05-10
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: negotiator@0.5.3
|
||||||
|
- Fix media type parameter matching to be case-insensitive
|
||||||
|
|
||||||
|
1.2.6 / 2015-05-07
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.0.11
|
||||||
|
- deps: mime-db@~1.9.1
|
||||||
|
* deps: negotiator@0.5.2
|
||||||
|
- Fix comparing media types with quoted values
|
||||||
|
- Fix splitting media types with quoted commas
|
||||||
|
|
||||||
|
1.2.5 / 2015-03-13
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.0.10
|
||||||
|
- deps: mime-db@~1.8.0
|
||||||
|
|
||||||
|
1.2.4 / 2015-02-14
|
||||||
|
==================
|
||||||
|
|
||||||
|
* Support Node.js 0.6
|
||||||
|
* deps: mime-types@~2.0.9
|
||||||
|
- deps: mime-db@~1.7.0
|
||||||
|
* deps: negotiator@0.5.1
|
||||||
|
- Fix preference sorting to be stable for long acceptable lists
|
||||||
|
|
||||||
|
1.2.3 / 2015-01-31
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.0.8
|
||||||
|
- deps: mime-db@~1.6.0
|
||||||
|
|
||||||
|
1.2.2 / 2014-12-30
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.0.7
|
||||||
|
- deps: mime-db@~1.5.0
|
||||||
|
|
||||||
|
1.2.1 / 2014-12-30
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.0.5
|
||||||
|
- deps: mime-db@~1.3.1
|
||||||
|
|
||||||
|
1.2.0 / 2014-12-19
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: negotiator@0.5.0
|
||||||
|
- Fix list return order when large accepted list
|
||||||
|
- Fix missing identity encoding when q=0 exists
|
||||||
|
- Remove dynamic building of Negotiator class
|
||||||
|
|
||||||
|
1.1.4 / 2014-12-10
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.0.4
|
||||||
|
- deps: mime-db@~1.3.0
|
||||||
|
|
||||||
|
1.1.3 / 2014-11-09
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.0.3
|
||||||
|
- deps: mime-db@~1.2.0
|
||||||
|
|
||||||
|
1.1.2 / 2014-10-14
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: negotiator@0.4.9
|
||||||
|
- Fix error when media type has invalid parameter
|
||||||
|
|
||||||
|
1.1.1 / 2014-09-28
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: mime-types@~2.0.2
|
||||||
|
- deps: mime-db@~1.1.0
|
||||||
|
* deps: negotiator@0.4.8
|
||||||
|
- Fix all negotiations to be case-insensitive
|
||||||
|
- Stable sort preferences of same quality according to client order
|
||||||
|
|
||||||
|
1.1.0 / 2014-09-02
|
||||||
|
==================
|
||||||
|
|
||||||
|
* update `mime-types`
|
||||||
|
|
||||||
|
1.0.7 / 2014-07-04
|
||||||
|
==================
|
||||||
|
|
||||||
|
* Fix wrong type returned from `type` when match after unknown extension
|
||||||
|
|
||||||
|
1.0.6 / 2014-06-24
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: negotiator@0.4.7
|
||||||
|
|
||||||
|
1.0.5 / 2014-06-20
|
||||||
|
==================
|
||||||
|
|
||||||
|
* fix crash when unknown extension given
|
||||||
|
|
||||||
|
1.0.4 / 2014-06-19
|
||||||
|
==================
|
||||||
|
|
||||||
|
* use `mime-types`
|
||||||
|
|
||||||
|
1.0.3 / 2014-06-11
|
||||||
|
==================
|
||||||
|
|
||||||
|
* deps: negotiator@0.4.6
|
||||||
|
- Order by specificity when quality is the same
|
||||||
|
|
||||||
|
1.0.2 / 2014-05-29
|
||||||
|
==================
|
||||||
|
|
||||||
|
* Fix interpretation when header not in request
|
||||||
|
* deps: pin negotiator@0.4.5
|
||||||
|
|
||||||
|
1.0.1 / 2014-01-18
|
||||||
|
==================
|
||||||
|
|
||||||
|
* Identity encoding isn't always acceptable
|
||||||
|
* deps: negotiator@~0.4.0
|
||||||
|
|
||||||
|
1.0.0 / 2013-12-27
|
||||||
|
==================
|
||||||
|
|
||||||
|
* Genesis
|
||||||
|
|
@ -0,0 +1,23 @@
|
||||||
|
(The MIT License)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Jonathan Ong <me@jongleberry.com>
|
||||||
|
Copyright (c) 2015 Douglas Christopher Wilson <doug@somethingdoug.com>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
|
a copy of this software and associated documentation files (the
|
||||||
|
'Software'), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish,
|
||||||
|
distribute, sublicense, and/or sell copies of the Software, and to
|
||||||
|
permit persons to whom the Software is furnished to do so, subject to
|
||||||
|
the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be
|
||||||
|
included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||||
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||||
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||||
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||||
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
@ -0,0 +1,140 @@
|
||||||
|
# accepts
|
||||||
|
|
||||||
|
[![NPM Version][npm-version-image]][npm-url]
|
||||||
|
[![NPM Downloads][npm-downloads-image]][npm-url]
|
||||||
|
[![Node.js Version][node-version-image]][node-version-url]
|
||||||
|
[![Build Status][github-actions-ci-image]][github-actions-ci-url]
|
||||||
|
[![Test Coverage][coveralls-image]][coveralls-url]
|
||||||
|
|
||||||
|
Higher level content negotiation based on [negotiator](https://www.npmjs.com/package/negotiator).
|
||||||
|
Extracted from [koa](https://www.npmjs.com/package/koa) for general use.
|
||||||
|
|
||||||
|
In addition to negotiator, it allows:
|
||||||
|
|
||||||
|
- Allows types as an array or arguments list, ie `(['text/html', 'application/json'])`
|
||||||
|
as well as `('text/html', 'application/json')`.
|
||||||
|
- Allows type shorthands such as `json`.
|
||||||
|
- Returns `false` when no types match
|
||||||
|
- Treats non-existent headers as `*`
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
This is a [Node.js](https://nodejs.org/en/) module available through the
|
||||||
|
[npm registry](https://www.npmjs.com/). Installation is done using the
|
||||||
|
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ npm install accepts
|
||||||
|
```
|
||||||
|
|
||||||
|
## API
|
||||||
|
|
||||||
|
```js
|
||||||
|
var accepts = require('accepts')
|
||||||
|
```
|
||||||
|
|
||||||
|
### accepts(req)
|
||||||
|
|
||||||
|
Create a new `Accepts` object for the given `req`.
|
||||||
|
|
||||||
|
#### .charset(charsets)
|
||||||
|
|
||||||
|
Return the first accepted charset. If nothing in `charsets` is accepted,
|
||||||
|
then `false` is returned.
|
||||||
|
|
||||||
|
#### .charsets()
|
||||||
|
|
||||||
|
Return the charsets that the request accepts, in the order of the client's
|
||||||
|
preference (most preferred first).
|
||||||
|
|
||||||
|
#### .encoding(encodings)
|
||||||
|
|
||||||
|
Return the first accepted encoding. If nothing in `encodings` is accepted,
|
||||||
|
then `false` is returned.
|
||||||
|
|
||||||
|
#### .encodings()
|
||||||
|
|
||||||
|
Return the encodings that the request accepts, in the order of the client's
|
||||||
|
preference (most preferred first).
|
||||||
|
|
||||||
|
#### .language(languages)
|
||||||
|
|
||||||
|
Return the first accepted language. If nothing in `languages` is accepted,
|
||||||
|
then `false` is returned.
|
||||||
|
|
||||||
|
#### .languages()
|
||||||
|
|
||||||
|
Return the languages that the request accepts, in the order of the client's
|
||||||
|
preference (most preferred first).
|
||||||
|
|
||||||
|
#### .type(types)
|
||||||
|
|
||||||
|
Return the first accepted type (and it is returned as the same text as what
|
||||||
|
appears in the `types` array). If nothing in `types` is accepted, then `false`
|
||||||
|
is returned.
|
||||||
|
|
||||||
|
The `types` array can contain full MIME types or file extensions. Any value
|
||||||
|
that is not a full MIME type is passed to `require('mime-types').lookup`.
|
||||||
|
|
||||||
|
#### .types()
|
||||||
|
|
||||||
|
Return the types that the request accepts, in the order of the client's
|
||||||
|
preference (most preferred first).
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Simple type negotiation
|
||||||
|
|
||||||
|
This simple example shows how to use `accepts` to return a different typed
|
||||||
|
respond body based on what the client wants to accept. The server lists it's
|
||||||
|
preferences in order and will get back the best match between the client and
|
||||||
|
server.
|
||||||
|
|
||||||
|
```js
|
||||||
|
var accepts = require('accepts')
|
||||||
|
var http = require('http')
|
||||||
|
|
||||||
|
function app (req, res) {
|
||||||
|
var accept = accepts(req)
|
||||||
|
|
||||||
|
// the order of this list is significant; should be server preferred order
|
||||||
|
switch (accept.type(['json', 'html'])) {
|
||||||
|
case 'json':
|
||||||
|
res.setHeader('Content-Type', 'application/json')
|
||||||
|
res.write('{"hello":"world!"}')
|
||||||
|
break
|
||||||
|
case 'html':
|
||||||
|
res.setHeader('Content-Type', 'text/html')
|
||||||
|
res.write('<b>hello, world!</b>')
|
||||||
|
break
|
||||||
|
default:
|
||||||
|
// the fallback is text/plain, so no need to specify it above
|
||||||
|
res.setHeader('Content-Type', 'text/plain')
|
||||||
|
res.write('hello, world!')
|
||||||
|
break
|
||||||
|
}
|
||||||
|
|
||||||
|
res.end()
|
||||||
|
}
|
||||||
|
|
||||||
|
http.createServer(app).listen(3000)
|
||||||
|
```
|
||||||
|
|
||||||
|
You can test this out with the cURL program:
|
||||||
|
```sh
|
||||||
|
curl -I -H'Accept: text/html' http://localhost:3000/
|
||||||
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](LICENSE)
|
||||||
|
|
||||||
|
[coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/accepts/master
|
||||||
|
[coveralls-url]: https://coveralls.io/r/jshttp/accepts?branch=master
|
||||||
|
[github-actions-ci-image]: https://badgen.net/github/checks/jshttp/accepts/master?label=ci
|
||||||
|
[github-actions-ci-url]: https://github.com/jshttp/accepts/actions/workflows/ci.yml
|
||||||
|
[node-version-image]: https://badgen.net/npm/node/accepts
|
||||||
|
[node-version-url]: https://nodejs.org/en/download
|
||||||
|
[npm-downloads-image]: https://badgen.net/npm/dm/accepts
|
||||||
|
[npm-url]: https://npmjs.org/package/accepts
|
||||||
|
[npm-version-image]: https://badgen.net/npm/v/accepts
|
||||||
|
|
@ -0,0 +1,238 @@
|
||||||
|
/*!
|
||||||
|
* accepts
|
||||||
|
* Copyright(c) 2014 Jonathan Ong
|
||||||
|
* Copyright(c) 2015 Douglas Christopher Wilson
|
||||||
|
* MIT Licensed
|
||||||
|
*/
|
||||||
|
|
||||||
|
'use strict'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Module dependencies.
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
|
||||||
|
var Negotiator = require('negotiator')
|
||||||
|
var mime = require('mime-types')
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Module exports.
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
|
||||||
|
module.exports = Accepts
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new Accepts object for the given req.
|
||||||
|
*
|
||||||
|
* @param {object} req
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
|
||||||
|
function Accepts (req) {
|
||||||
|
if (!(this instanceof Accepts)) {
|
||||||
|
return new Accepts(req)
|
||||||
|
}
|
||||||
|
|
||||||
|
this.headers = req.headers
|
||||||
|
this.negotiator = new Negotiator(req)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the given `type(s)` is acceptable, returning
|
||||||
|
* the best match when true, otherwise `undefined`, in which
|
||||||
|
* case you should respond with 406 "Not Acceptable".
|
||||||
|
*
|
||||||
|
* The `type` value may be a single mime type string
|
||||||
|
* such as "application/json", the extension name
|
||||||
|
* such as "json" or an array `["json", "html", "text/plain"]`. When a list
|
||||||
|
* or array is given the _best_ match, if any is returned.
|
||||||
|
*
|
||||||
|
* Examples:
|
||||||
|
*
|
||||||
|
* // Accept: text/html
|
||||||
|
* this.types('html');
|
||||||
|
* // => "html"
|
||||||
|
*
|
||||||
|
* // Accept: text/*, application/json
|
||||||
|
* this.types('html');
|
||||||
|
* // => "html"
|
||||||
|
* this.types('text/html');
|
||||||
|
* // => "text/html"
|
||||||
|
* this.types('json', 'text');
|
||||||
|
* // => "json"
|
||||||
|
* this.types('application/json');
|
||||||
|
* // => "application/json"
|
||||||
|
*
|
||||||
|
* // Accept: text/*, application/json
|
||||||
|
* this.types('image/png');
|
||||||
|
* this.types('png');
|
||||||
|
* // => undefined
|
||||||
|
*
|
||||||
|
* // Accept: text/*;q=.5, application/json
|
||||||
|
* this.types(['html', 'json']);
|
||||||
|
* this.types('html', 'json');
|
||||||
|
* // => "json"
|
||||||
|
*
|
||||||
|
* @param {String|Array} types...
|
||||||
|
* @return {String|Array|Boolean}
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
|
||||||
|
Accepts.prototype.type =
|
||||||
|
Accepts.prototype.types = function (types_) {
|
||||||
|
var types = types_
|
||||||
|
|
||||||
|
// support flattened arguments
|
||||||
|
if (types && !Array.isArray(types)) {
|
||||||
|
types = new Array(arguments.length)
|
||||||
|
for (var i = 0; i < types.length; i++) {
|
||||||
|
types[i] = arguments[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no types, return all requested types
|
||||||
|
if (!types || types.length === 0) {
|
||||||
|
return this.negotiator.mediaTypes()
|
||||||
|
}
|
||||||
|
|
||||||
|
// no accept header, return first given type
|
||||||
|
if (!this.headers.accept) {
|
||||||
|
return types[0]
|
||||||
|
}
|
||||||
|
|
||||||
|
var mimes = types.map(extToMime)
|
||||||
|
var accepts = this.negotiator.mediaTypes(mimes.filter(validMime))
|
||||||
|
var first = accepts[0]
|
||||||
|
|
||||||
|
return first
|
||||||
|
? types[mimes.indexOf(first)]
|
||||||
|
: false
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return accepted encodings or best fit based on `encodings`.
|
||||||
|
*
|
||||||
|
* Given `Accept-Encoding: gzip, deflate`
|
||||||
|
* an array sorted by quality is returned:
|
||||||
|
*
|
||||||
|
* ['gzip', 'deflate']
|
||||||
|
*
|
||||||
|
* @param {String|Array} encodings...
|
||||||
|
* @return {String|Array}
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
|
||||||
|
Accepts.prototype.encoding =
|
||||||
|
Accepts.prototype.encodings = function (encodings_) {
|
||||||
|
var encodings = encodings_
|
||||||
|
|
||||||
|
// support flattened arguments
|
||||||
|
if (encodings && !Array.isArray(encodings)) {
|
||||||
|
encodings = new Array(arguments.length)
|
||||||
|
for (var i = 0; i < encodings.length; i++) {
|
||||||
|
encodings[i] = arguments[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no encodings, return all requested encodings
|
||||||
|
if (!encodings || encodings.length === 0) {
|
||||||
|
return this.negotiator.encodings()
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.negotiator.encodings(encodings)[0] || false
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return accepted charsets or best fit based on `charsets`.
|
||||||
|
*
|
||||||
|
* Given `Accept-Charset: utf-8, iso-8859-1;q=0.2, utf-7;q=0.5`
|
||||||
|
* an array sorted by quality is returned:
|
||||||
|
*
|
||||||
|
* ['utf-8', 'utf-7', 'iso-8859-1']
|
||||||
|
*
|
||||||
|
* @param {String|Array} charsets...
|
||||||
|
* @return {String|Array}
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
|
||||||
|
Accepts.prototype.charset =
|
||||||
|
Accepts.prototype.charsets = function (charsets_) {
|
||||||
|
var charsets = charsets_
|
||||||
|
|
||||||
|
// support flattened arguments
|
||||||
|
if (charsets && !Array.isArray(charsets)) {
|
||||||
|
charsets = new Array(arguments.length)
|
||||||
|
for (var i = 0; i < charsets.length; i++) {
|
||||||
|
charsets[i] = arguments[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no charsets, return all requested charsets
|
||||||
|
if (!charsets || charsets.length === 0) {
|
||||||
|
return this.negotiator.charsets()
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.negotiator.charsets(charsets)[0] || false
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Return accepted languages or best fit based on `langs`.
|
||||||
|
*
|
||||||
|
* Given `Accept-Language: en;q=0.8, es, pt`
|
||||||
|
* an array sorted by quality is returned:
|
||||||
|
*
|
||||||
|
* ['es', 'pt', 'en']
|
||||||
|
*
|
||||||
|
* @param {String|Array} langs...
|
||||||
|
* @return {Array|String}
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
|
|
||||||
|
Accepts.prototype.lang =
|
||||||
|
Accepts.prototype.langs =
|
||||||
|
Accepts.prototype.language =
|
||||||
|
Accepts.prototype.languages = function (languages_) {
|
||||||
|
var languages = languages_
|
||||||
|
|
||||||
|
// support flattened arguments
|
||||||
|
if (languages && !Array.isArray(languages)) {
|
||||||
|
languages = new Array(arguments.length)
|
||||||
|
for (var i = 0; i < languages.length; i++) {
|
||||||
|
languages[i] = arguments[i]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// no languages, return all requested languages
|
||||||
|
if (!languages || languages.length === 0) {
|
||||||
|
return this.negotiator.languages()
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.negotiator.languages(languages)[0] || false
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Convert extnames to mime.
|
||||||
|
*
|
||||||
|
* @param {String} type
|
||||||
|
* @return {String}
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
|
||||||
|
function extToMime (type) {
|
||||||
|
return type.indexOf('/') === -1
|
||||||
|
? mime.lookup(type)
|
||||||
|
: type
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if mime is valid.
|
||||||
|
*
|
||||||
|
* @param {String} type
|
||||||
|
* @return {Boolean}
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
|
||||||
|
function validMime (type) {
|
||||||
|
return typeof type === 'string'
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,47 @@
|
||||||
|
{
|
||||||
|
"name": "accepts",
|
||||||
|
"description": "Higher-level content negotiation",
|
||||||
|
"version": "2.0.0",
|
||||||
|
"contributors": [
|
||||||
|
"Douglas Christopher Wilson <doug@somethingdoug.com>",
|
||||||
|
"Jonathan Ong <me@jongleberry.com> (http://jongleberry.com)"
|
||||||
|
],
|
||||||
|
"license": "MIT",
|
||||||
|
"repository": "jshttp/accepts",
|
||||||
|
"dependencies": {
|
||||||
|
"mime-types": "^3.0.0",
|
||||||
|
"negotiator": "^1.0.0"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"deep-equal": "1.0.1",
|
||||||
|
"eslint": "7.32.0",
|
||||||
|
"eslint-config-standard": "14.1.1",
|
||||||
|
"eslint-plugin-import": "2.25.4",
|
||||||
|
"eslint-plugin-markdown": "2.2.1",
|
||||||
|
"eslint-plugin-node": "11.1.0",
|
||||||
|
"eslint-plugin-promise": "4.3.1",
|
||||||
|
"eslint-plugin-standard": "4.1.0",
|
||||||
|
"mocha": "9.2.0",
|
||||||
|
"nyc": "15.1.0"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"LICENSE",
|
||||||
|
"HISTORY.md",
|
||||||
|
"index.js"
|
||||||
|
],
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 0.6"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"lint": "eslint .",
|
||||||
|
"test": "mocha --reporter spec --check-leaks --bail test/",
|
||||||
|
"test-ci": "nyc --reporter=lcov --reporter=text npm test",
|
||||||
|
"test-cov": "nyc --reporter=html --reporter=text npm test"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"content",
|
||||||
|
"negotiation",
|
||||||
|
"accept",
|
||||||
|
"accepts"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,145 @@
|
||||||
|
agent-base
|
||||||
|
==========
|
||||||
|
### Turn a function into an [`http.Agent`][http.Agent] instance
|
||||||
|
[](https://github.com/TooTallNate/node-agent-base/actions?workflow=Node+CI)
|
||||||
|
|
||||||
|
This module provides an `http.Agent` generator. That is, you pass it an async
|
||||||
|
callback function, and it returns a new `http.Agent` instance that will invoke the
|
||||||
|
given callback function when sending outbound HTTP requests.
|
||||||
|
|
||||||
|
#### Some subclasses:
|
||||||
|
|
||||||
|
Here's some more interesting uses of `agent-base`.
|
||||||
|
Send a pull request to list yours!
|
||||||
|
|
||||||
|
* [`http-proxy-agent`][http-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTP endpoints
|
||||||
|
* [`https-proxy-agent`][https-proxy-agent]: An HTTP(s) proxy `http.Agent` implementation for HTTPS endpoints
|
||||||
|
* [`pac-proxy-agent`][pac-proxy-agent]: A PAC file proxy `http.Agent` implementation for HTTP and HTTPS
|
||||||
|
* [`socks-proxy-agent`][socks-proxy-agent]: A SOCKS proxy `http.Agent` implementation for HTTP and HTTPS
|
||||||
|
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
Install with `npm`:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
$ npm install agent-base
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
Example
|
||||||
|
-------
|
||||||
|
|
||||||
|
Here's a minimal example that creates a new `net.Socket` connection to the server
|
||||||
|
for every HTTP request (i.e. the equivalent of `agent: false` option):
|
||||||
|
|
||||||
|
```js
|
||||||
|
var net = require('net');
|
||||||
|
var tls = require('tls');
|
||||||
|
var url = require('url');
|
||||||
|
var http = require('http');
|
||||||
|
var agent = require('agent-base');
|
||||||
|
|
||||||
|
var endpoint = 'http://nodejs.org/api/';
|
||||||
|
var parsed = url.parse(endpoint);
|
||||||
|
|
||||||
|
// This is the important part!
|
||||||
|
parsed.agent = agent(function (req, opts) {
|
||||||
|
var socket;
|
||||||
|
// `secureEndpoint` is true when using the https module
|
||||||
|
if (opts.secureEndpoint) {
|
||||||
|
socket = tls.connect(opts);
|
||||||
|
} else {
|
||||||
|
socket = net.connect(opts);
|
||||||
|
}
|
||||||
|
return socket;
|
||||||
|
});
|
||||||
|
|
||||||
|
// Everything else works just like normal...
|
||||||
|
http.get(parsed, function (res) {
|
||||||
|
console.log('"response" event!', res.headers);
|
||||||
|
res.pipe(process.stdout);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Returning a Promise or using an `async` function is also supported:
|
||||||
|
|
||||||
|
```js
|
||||||
|
agent(async function (req, opts) {
|
||||||
|
await sleep(1000);
|
||||||
|
// etc…
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
Return another `http.Agent` instance to "pass through" the responsibility
|
||||||
|
for that HTTP request to that agent:
|
||||||
|
|
||||||
|
```js
|
||||||
|
agent(function (req, opts) {
|
||||||
|
return opts.secureEndpoint ? https.globalAgent : http.globalAgent;
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
API
|
||||||
|
---
|
||||||
|
|
||||||
|
## Agent(Function callback[, Object options]) → [http.Agent][]
|
||||||
|
|
||||||
|
Creates a base `http.Agent` that will execute the callback function `callback`
|
||||||
|
for every HTTP request that it is used as the `agent` for. The callback function
|
||||||
|
is responsible for creating a `stream.Duplex` instance of some kind that will be
|
||||||
|
used as the underlying socket in the HTTP request.
|
||||||
|
|
||||||
|
The `options` object accepts the following properties:
|
||||||
|
|
||||||
|
* `timeout` - Number - Timeout for the `callback()` function in milliseconds. Defaults to Infinity (optional).
|
||||||
|
|
||||||
|
The callback function should have the following signature:
|
||||||
|
|
||||||
|
### callback(http.ClientRequest req, Object options, Function cb) → undefined
|
||||||
|
|
||||||
|
The ClientRequest `req` can be accessed to read request headers and
|
||||||
|
and the path, etc. The `options` object contains the options passed
|
||||||
|
to the `http.request()`/`https.request()` function call, and is formatted
|
||||||
|
to be directly passed to `net.connect()`/`tls.connect()`, or however
|
||||||
|
else you want a Socket to be created. Pass the created socket to
|
||||||
|
the callback function `cb` once created, and the HTTP request will
|
||||||
|
continue to proceed.
|
||||||
|
|
||||||
|
If the `https` module is used to invoke the HTTP request, then the
|
||||||
|
`secureEndpoint` property on `options` _will be set to `true`_.
|
||||||
|
|
||||||
|
|
||||||
|
License
|
||||||
|
-------
|
||||||
|
|
||||||
|
(The MIT License)
|
||||||
|
|
||||||
|
Copyright (c) 2013 Nathan Rajlich <nathan@tootallnate.net>
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining
|
||||||
|
a copy of this software and associated documentation files (the
|
||||||
|
'Software'), to deal in the Software without restriction, including
|
||||||
|
without limitation the rights to use, copy, modify, merge, publish,
|
||||||
|
distribute, sublicense, and/or sell copies of the Software, and to
|
||||||
|
permit persons to whom the Software is furnished to do so, subject to
|
||||||
|
the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be
|
||||||
|
included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
||||||
|
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||||
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
||||||
|
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
||||||
|
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
||||||
|
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||||
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
[http-proxy-agent]: https://github.com/TooTallNate/node-http-proxy-agent
|
||||||
|
[https-proxy-agent]: https://github.com/TooTallNate/node-https-proxy-agent
|
||||||
|
[pac-proxy-agent]: https://github.com/TooTallNate/node-pac-proxy-agent
|
||||||
|
[socks-proxy-agent]: https://github.com/TooTallNate/node-socks-proxy-agent
|
||||||
|
[http.Agent]: https://nodejs.org/api/http.html#http_class_http_agent
|
||||||
|
|
@ -0,0 +1,78 @@
|
||||||
|
/// <reference types="node" />
|
||||||
|
import net from 'net';
|
||||||
|
import http from 'http';
|
||||||
|
import https from 'https';
|
||||||
|
import { Duplex } from 'stream';
|
||||||
|
import { EventEmitter } from 'events';
|
||||||
|
declare function createAgent(opts?: createAgent.AgentOptions): createAgent.Agent;
|
||||||
|
declare function createAgent(callback: createAgent.AgentCallback, opts?: createAgent.AgentOptions): createAgent.Agent;
|
||||||
|
declare namespace createAgent {
|
||||||
|
interface ClientRequest extends http.ClientRequest {
|
||||||
|
_last?: boolean;
|
||||||
|
_hadError?: boolean;
|
||||||
|
method: string;
|
||||||
|
}
|
||||||
|
interface AgentRequestOptions {
|
||||||
|
host?: string;
|
||||||
|
path?: string;
|
||||||
|
port: number;
|
||||||
|
}
|
||||||
|
interface HttpRequestOptions extends AgentRequestOptions, Omit<http.RequestOptions, keyof AgentRequestOptions> {
|
||||||
|
secureEndpoint: false;
|
||||||
|
}
|
||||||
|
interface HttpsRequestOptions extends AgentRequestOptions, Omit<https.RequestOptions, keyof AgentRequestOptions> {
|
||||||
|
secureEndpoint: true;
|
||||||
|
}
|
||||||
|
type RequestOptions = HttpRequestOptions | HttpsRequestOptions;
|
||||||
|
type AgentLike = Pick<createAgent.Agent, 'addRequest'> | http.Agent;
|
||||||
|
type AgentCallbackReturn = Duplex | AgentLike;
|
||||||
|
type AgentCallbackCallback = (err?: Error | null, socket?: createAgent.AgentCallbackReturn) => void;
|
||||||
|
type AgentCallbackPromise = (req: createAgent.ClientRequest, opts: createAgent.RequestOptions) => createAgent.AgentCallbackReturn | Promise<createAgent.AgentCallbackReturn>;
|
||||||
|
type AgentCallback = typeof Agent.prototype.callback;
|
||||||
|
type AgentOptions = {
|
||||||
|
timeout?: number;
|
||||||
|
};
|
||||||
|
/**
|
||||||
|
* Base `http.Agent` implementation.
|
||||||
|
* No pooling/keep-alive is implemented by default.
|
||||||
|
*
|
||||||
|
* @param {Function} callback
|
||||||
|
* @api public
|
||||||
|
*/
|
||||||
|
class Agent extends EventEmitter {
|
||||||
|
timeout: number | null;
|
||||||
|
maxFreeSockets: number;
|
||||||
|
maxTotalSockets: number;
|
||||||
|
maxSockets: number;
|
||||||
|
sockets: {
|
||||||
|
[key: string]: net.Socket[];
|
||||||
|
};
|
||||||
|
freeSockets: {
|
||||||
|
[key: string]: net.Socket[];
|
||||||
|
};
|
||||||
|
requests: {
|
||||||
|
[key: string]: http.IncomingMessage[];
|
||||||
|
};
|
||||||
|
options: https.AgentOptions;
|
||||||
|
private promisifiedCallback?;
|
||||||
|
private explicitDefaultPort?;
|
||||||
|
private explicitProtocol?;
|
||||||
|
constructor(callback?: createAgent.AgentCallback | createAgent.AgentOptions, _opts?: createAgent.AgentOptions);
|
||||||
|
get defaultPort(): number;
|
||||||
|
set defaultPort(v: number);
|
||||||
|
get protocol(): string;
|
||||||
|
set protocol(v: string);
|
||||||
|
callback(req: createAgent.ClientRequest, opts: createAgent.RequestOptions, fn: createAgent.AgentCallbackCallback): void;
|
||||||
|
callback(req: createAgent.ClientRequest, opts: createAgent.RequestOptions): createAgent.AgentCallbackReturn | Promise<createAgent.AgentCallbackReturn>;
|
||||||
|
/**
|
||||||
|
* Called by node-core's "_http_client.js" module when creating
|
||||||
|
* a new HTTP request with this Agent instance.
|
||||||
|
*
|
||||||
|
* @api public
|
||||||
|
*/
|
||||||
|
addRequest(req: ClientRequest, _opts: RequestOptions): void;
|
||||||
|
freeSocket(socket: net.Socket, opts: AgentOptions): void;
|
||||||
|
destroy(): void;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
export = createAgent;
|
||||||
|
|
@ -0,0 +1,203 @@
|
||||||
|
"use strict";
|
||||||
|
var __importDefault = (this && this.__importDefault) || function (mod) {
|
||||||
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
||||||
|
};
|
||||||
|
const events_1 = require("events");
|
||||||
|
const debug_1 = __importDefault(require("debug"));
|
||||||
|
const promisify_1 = __importDefault(require("./promisify"));
|
||||||
|
const debug = debug_1.default('agent-base');
|
||||||
|
function isAgent(v) {
|
||||||
|
return Boolean(v) && typeof v.addRequest === 'function';
|
||||||
|
}
|
||||||
|
function isSecureEndpoint() {
|
||||||
|
const { stack } = new Error();
|
||||||
|
if (typeof stack !== 'string')
|
||||||
|
return false;
|
||||||
|
return stack.split('\n').some(l => l.indexOf('(https.js:') !== -1 || l.indexOf('node:https:') !== -1);
|
||||||
|
}
|
||||||
|
function createAgent(callback, opts) {
|
||||||
|
return new createAgent.Agent(callback, opts);
|
||||||
|
}
|
||||||
|
(function (createAgent) {
|
||||||
|
/**
|
||||||
|
* Base `http.Agent` implementation.
|
||||||
|
* No pooling/keep-alive is implemented by default.
|
||||||
|
*
|
||||||
|
* @param {Function} callback
|
||||||
|
* @api public
|
||||||
|
*/
|
||||||
|
class Agent extends events_1.EventEmitter {
|
||||||
|
constructor(callback, _opts) {
|
||||||
|
super();
|
||||||
|
let opts = _opts;
|
||||||
|
if (typeof callback === 'function') {
|
||||||
|
this.callback = callback;
|
||||||
|
}
|
||||||
|
else if (callback) {
|
||||||
|
opts = callback;
|
||||||
|
}
|
||||||
|
// Timeout for the socket to be returned from the callback
|
||||||
|
this.timeout = null;
|
||||||
|
if (opts && typeof opts.timeout === 'number') {
|
||||||
|
this.timeout = opts.timeout;
|
||||||
|
}
|
||||||
|
// These aren't actually used by `agent-base`, but are required
|
||||||
|
// for the TypeScript definition files in `@types/node` :/
|
||||||
|
this.maxFreeSockets = 1;
|
||||||
|
this.maxSockets = 1;
|
||||||
|
this.maxTotalSockets = Infinity;
|
||||||
|
this.sockets = {};
|
||||||
|
this.freeSockets = {};
|
||||||
|
this.requests = {};
|
||||||
|
this.options = {};
|
||||||
|
}
|
||||||
|
get defaultPort() {
|
||||||
|
if (typeof this.explicitDefaultPort === 'number') {
|
||||||
|
return this.explicitDefaultPort;
|
||||||
|
}
|
||||||
|
return isSecureEndpoint() ? 443 : 80;
|
||||||
|
}
|
||||||
|
set defaultPort(v) {
|
||||||
|
this.explicitDefaultPort = v;
|
||||||
|
}
|
||||||
|
get protocol() {
|
||||||
|
if (typeof this.explicitProtocol === 'string') {
|
||||||
|
return this.explicitProtocol;
|
||||||
|
}
|
||||||
|
return isSecureEndpoint() ? 'https:' : 'http:';
|
||||||
|
}
|
||||||
|
set protocol(v) {
|
||||||
|
this.explicitProtocol = v;
|
||||||
|
}
|
||||||
|
callback(req, opts, fn) {
|
||||||
|
throw new Error('"agent-base" has no default implementation, you must subclass and override `callback()`');
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* Called by node-core's "_http_client.js" module when creating
|
||||||
|
* a new HTTP request with this Agent instance.
|
||||||
|
*
|
||||||
|
* @api public
|
||||||
|
*/
|
||||||
|
addRequest(req, _opts) {
|
||||||
|
const opts = Object.assign({}, _opts);
|
||||||
|
if (typeof opts.secureEndpoint !== 'boolean') {
|
||||||
|
opts.secureEndpoint = isSecureEndpoint();
|
||||||
|
}
|
||||||
|
if (opts.host == null) {
|
||||||
|
opts.host = 'localhost';
|
||||||
|
}
|
||||||
|
if (opts.port == null) {
|
||||||
|
opts.port = opts.secureEndpoint ? 443 : 80;
|
||||||
|
}
|
||||||
|
if (opts.protocol == null) {
|
||||||
|
opts.protocol = opts.secureEndpoint ? 'https:' : 'http:';
|
||||||
|
}
|
||||||
|
if (opts.host && opts.path) {
|
||||||
|
// If both a `host` and `path` are specified then it's most
|
||||||
|
// likely the result of a `url.parse()` call... we need to
|
||||||
|
// remove the `path` portion so that `net.connect()` doesn't
|
||||||
|
// attempt to open that as a unix socket file.
|
||||||
|
delete opts.path;
|
||||||
|
}
|
||||||
|
delete opts.agent;
|
||||||
|
delete opts.hostname;
|
||||||
|
delete opts._defaultAgent;
|
||||||
|
delete opts.defaultPort;
|
||||||
|
delete opts.createConnection;
|
||||||
|
// Hint to use "Connection: close"
|
||||||
|
// XXX: non-documented `http` module API :(
|
||||||
|
req._last = true;
|
||||||
|
req.shouldKeepAlive = false;
|
||||||
|
let timedOut = false;
|
||||||
|
let timeoutId = null;
|
||||||
|
const timeoutMs = opts.timeout || this.timeout;
|
||||||
|
const onerror = (err) => {
|
||||||
|
if (req._hadError)
|
||||||
|
return;
|
||||||
|
req.emit('error', err);
|
||||||
|
// For Safety. Some additional errors might fire later on
|
||||||
|
// and we need to make sure we don't double-fire the error event.
|
||||||
|
req._hadError = true;
|
||||||
|
};
|
||||||
|
const ontimeout = () => {
|
||||||
|
timeoutId = null;
|
||||||
|
timedOut = true;
|
||||||
|
const err = new Error(`A "socket" was not created for HTTP request before ${timeoutMs}ms`);
|
||||||
|
err.code = 'ETIMEOUT';
|
||||||
|
onerror(err);
|
||||||
|
};
|
||||||
|
const callbackError = (err) => {
|
||||||
|
if (timedOut)
|
||||||
|
return;
|
||||||
|
if (timeoutId !== null) {
|
||||||
|
clearTimeout(timeoutId);
|
||||||
|
timeoutId = null;
|
||||||
|
}
|
||||||
|
onerror(err);
|
||||||
|
};
|
||||||
|
const onsocket = (socket) => {
|
||||||
|
if (timedOut)
|
||||||
|
return;
|
||||||
|
if (timeoutId != null) {
|
||||||
|
clearTimeout(timeoutId);
|
||||||
|
timeoutId = null;
|
||||||
|
}
|
||||||
|
if (isAgent(socket)) {
|
||||||
|
// `socket` is actually an `http.Agent` instance, so
|
||||||
|
// relinquish responsibility for this `req` to the Agent
|
||||||
|
// from here on
|
||||||
|
debug('Callback returned another Agent instance %o', socket.constructor.name);
|
||||||
|
socket.addRequest(req, opts);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (socket) {
|
||||||
|
socket.once('free', () => {
|
||||||
|
this.freeSocket(socket, opts);
|
||||||
|
});
|
||||||
|
req.onSocket(socket);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const err = new Error(`no Duplex stream was returned to agent-base for \`${req.method} ${req.path}\``);
|
||||||
|
onerror(err);
|
||||||
|
};
|
||||||
|
if (typeof this.callback !== 'function') {
|
||||||
|
onerror(new Error('`callback` is not defined'));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
if (!this.promisifiedCallback) {
|
||||||
|
if (this.callback.length >= 3) {
|
||||||
|
debug('Converting legacy callback function to promise');
|
||||||
|
this.promisifiedCallback = promisify_1.default(this.callback);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
this.promisifiedCallback = this.callback;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (typeof timeoutMs === 'number' && timeoutMs > 0) {
|
||||||
|
timeoutId = setTimeout(ontimeout, timeoutMs);
|
||||||
|
}
|
||||||
|
if ('port' in opts && typeof opts.port !== 'number') {
|
||||||
|
opts.port = Number(opts.port);
|
||||||
|
}
|
||||||
|
try {
|
||||||
|
debug('Resolving socket for %o request: %o', opts.protocol, `${req.method} ${req.path}`);
|
||||||
|
Promise.resolve(this.promisifiedCallback(req, opts)).then(onsocket, callbackError);
|
||||||
|
}
|
||||||
|
catch (err) {
|
||||||
|
Promise.reject(err).catch(callbackError);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
freeSocket(socket, opts) {
|
||||||
|
debug('Freeing socket %o %o', socket.constructor.name, opts);
|
||||||
|
socket.destroy();
|
||||||
|
}
|
||||||
|
destroy() {
|
||||||
|
debug('Destroying agent %o', this.constructor.name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
createAgent.Agent = Agent;
|
||||||
|
// So that `instanceof` works correctly
|
||||||
|
createAgent.prototype = createAgent.Agent.prototype;
|
||||||
|
})(createAgent || (createAgent = {}));
|
||||||
|
module.exports = createAgent;
|
||||||
|
//# sourceMappingURL=index.js.map
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,4 @@
|
||||||
|
import { ClientRequest, RequestOptions, AgentCallbackCallback, AgentCallbackPromise } from './index';
|
||||||
|
declare type LegacyCallback = (req: ClientRequest, opts: RequestOptions, fn: AgentCallbackCallback) => void;
|
||||||
|
export default function promisify(fn: LegacyCallback): AgentCallbackPromise;
|
||||||
|
export {};
|
||||||
|
|
@ -0,0 +1,18 @@
|
||||||
|
"use strict";
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
function promisify(fn) {
|
||||||
|
return function (req, opts) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
fn.call(this, req, opts, (err, rtn) => {
|
||||||
|
if (err) {
|
||||||
|
reject(err);
|
||||||
|
}
|
||||||
|
else {
|
||||||
|
resolve(rtn);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
};
|
||||||
|
}
|
||||||
|
exports.default = promisify;
|
||||||
|
//# sourceMappingURL=promisify.js.map
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
{"version":3,"file":"promisify.js","sourceRoot":"","sources":["../../src/promisify.ts"],"names":[],"mappings":";;AAeA,SAAwB,SAAS,CAAC,EAAkB;IACnD,OAAO,UAAsB,GAAkB,EAAE,IAAoB;QACpE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtC,EAAE,CAAC,IAAI,CACN,IAAI,EACJ,GAAG,EACH,IAAI,EACJ,CAAC,GAA6B,EAAE,GAAyB,EAAE,EAAE;gBAC5D,IAAI,GAAG,EAAE;oBACR,MAAM,CAAC,GAAG,CAAC,CAAC;iBACZ;qBAAM;oBACN,OAAO,CAAC,GAAG,CAAC,CAAC;iBACb;YACF,CAAC,CACD,CAAC;QACH,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC;AACH,CAAC;AAjBD,4BAiBC"}
|
||||||
|
|
@ -0,0 +1,64 @@
|
||||||
|
{
|
||||||
|
"name": "agent-base",
|
||||||
|
"version": "6.0.2",
|
||||||
|
"description": "Turn a function into an `http.Agent` instance",
|
||||||
|
"main": "dist/src/index",
|
||||||
|
"typings": "dist/src/index",
|
||||||
|
"files": [
|
||||||
|
"dist/src",
|
||||||
|
"src"
|
||||||
|
],
|
||||||
|
"scripts": {
|
||||||
|
"prebuild": "rimraf dist",
|
||||||
|
"build": "tsc",
|
||||||
|
"postbuild": "cpy --parents src test '!**/*.ts' dist",
|
||||||
|
"test": "mocha --reporter spec dist/test/*.js",
|
||||||
|
"test-lint": "eslint src --ext .js,.ts",
|
||||||
|
"prepublishOnly": "npm run build"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git://github.com/TooTallNate/node-agent-base.git"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"http",
|
||||||
|
"agent",
|
||||||
|
"base",
|
||||||
|
"barebones",
|
||||||
|
"https"
|
||||||
|
],
|
||||||
|
"author": "Nathan Rajlich <nathan@tootallnate.net> (http://n8.io/)",
|
||||||
|
"license": "MIT",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/TooTallNate/node-agent-base/issues"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"debug": "4"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/debug": "4",
|
||||||
|
"@types/mocha": "^5.2.7",
|
||||||
|
"@types/node": "^14.0.20",
|
||||||
|
"@types/semver": "^7.1.0",
|
||||||
|
"@types/ws": "^6.0.3",
|
||||||
|
"@typescript-eslint/eslint-plugin": "1.6.0",
|
||||||
|
"@typescript-eslint/parser": "1.1.0",
|
||||||
|
"async-listen": "^1.2.0",
|
||||||
|
"cpy-cli": "^2.0.0",
|
||||||
|
"eslint": "5.16.0",
|
||||||
|
"eslint-config-airbnb": "17.1.0",
|
||||||
|
"eslint-config-prettier": "4.1.0",
|
||||||
|
"eslint-import-resolver-typescript": "1.1.1",
|
||||||
|
"eslint-plugin-import": "2.16.0",
|
||||||
|
"eslint-plugin-jsx-a11y": "6.2.1",
|
||||||
|
"eslint-plugin-react": "7.12.4",
|
||||||
|
"mocha": "^6.2.0",
|
||||||
|
"rimraf": "^3.0.0",
|
||||||
|
"semver": "^7.1.2",
|
||||||
|
"typescript": "^3.5.3",
|
||||||
|
"ws": "^3.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 6.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,345 @@
|
||||||
|
import net from 'net';
|
||||||
|
import http from 'http';
|
||||||
|
import https from 'https';
|
||||||
|
import { Duplex } from 'stream';
|
||||||
|
import { EventEmitter } from 'events';
|
||||||
|
import createDebug from 'debug';
|
||||||
|
import promisify from './promisify';
|
||||||
|
|
||||||
|
const debug = createDebug('agent-base');
|
||||||
|
|
||||||
|
function isAgent(v: any): v is createAgent.AgentLike {
|
||||||
|
return Boolean(v) && typeof v.addRequest === 'function';
|
||||||
|
}
|
||||||
|
|
||||||
|
function isSecureEndpoint(): boolean {
|
||||||
|
const { stack } = new Error();
|
||||||
|
if (typeof stack !== 'string') return false;
|
||||||
|
return stack.split('\n').some(l => l.indexOf('(https.js:') !== -1 || l.indexOf('node:https:') !== -1);
|
||||||
|
}
|
||||||
|
|
||||||
|
function createAgent(opts?: createAgent.AgentOptions): createAgent.Agent;
|
||||||
|
function createAgent(
|
||||||
|
callback: createAgent.AgentCallback,
|
||||||
|
opts?: createAgent.AgentOptions
|
||||||
|
): createAgent.Agent;
|
||||||
|
function createAgent(
|
||||||
|
callback?: createAgent.AgentCallback | createAgent.AgentOptions,
|
||||||
|
opts?: createAgent.AgentOptions
|
||||||
|
) {
|
||||||
|
return new createAgent.Agent(callback, opts);
|
||||||
|
}
|
||||||
|
|
||||||
|
namespace createAgent {
|
||||||
|
export interface ClientRequest extends http.ClientRequest {
|
||||||
|
_last?: boolean;
|
||||||
|
_hadError?: boolean;
|
||||||
|
method: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AgentRequestOptions {
|
||||||
|
host?: string;
|
||||||
|
path?: string;
|
||||||
|
// `port` on `http.RequestOptions` can be a string or undefined,
|
||||||
|
// but `net.TcpNetConnectOpts` expects only a number
|
||||||
|
port: number;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface HttpRequestOptions
|
||||||
|
extends AgentRequestOptions,
|
||||||
|
Omit<http.RequestOptions, keyof AgentRequestOptions> {
|
||||||
|
secureEndpoint: false;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface HttpsRequestOptions
|
||||||
|
extends AgentRequestOptions,
|
||||||
|
Omit<https.RequestOptions, keyof AgentRequestOptions> {
|
||||||
|
secureEndpoint: true;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type RequestOptions = HttpRequestOptions | HttpsRequestOptions;
|
||||||
|
|
||||||
|
export type AgentLike = Pick<createAgent.Agent, 'addRequest'> | http.Agent;
|
||||||
|
|
||||||
|
export type AgentCallbackReturn = Duplex | AgentLike;
|
||||||
|
|
||||||
|
export type AgentCallbackCallback = (
|
||||||
|
err?: Error | null,
|
||||||
|
socket?: createAgent.AgentCallbackReturn
|
||||||
|
) => void;
|
||||||
|
|
||||||
|
export type AgentCallbackPromise = (
|
||||||
|
req: createAgent.ClientRequest,
|
||||||
|
opts: createAgent.RequestOptions
|
||||||
|
) =>
|
||||||
|
| createAgent.AgentCallbackReturn
|
||||||
|
| Promise<createAgent.AgentCallbackReturn>;
|
||||||
|
|
||||||
|
export type AgentCallback = typeof Agent.prototype.callback;
|
||||||
|
|
||||||
|
export type AgentOptions = {
|
||||||
|
timeout?: number;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Base `http.Agent` implementation.
|
||||||
|
* No pooling/keep-alive is implemented by default.
|
||||||
|
*
|
||||||
|
* @param {Function} callback
|
||||||
|
* @api public
|
||||||
|
*/
|
||||||
|
export class Agent extends EventEmitter {
|
||||||
|
public timeout: number | null;
|
||||||
|
public maxFreeSockets: number;
|
||||||
|
public maxTotalSockets: number;
|
||||||
|
public maxSockets: number;
|
||||||
|
public sockets: {
|
||||||
|
[key: string]: net.Socket[];
|
||||||
|
};
|
||||||
|
public freeSockets: {
|
||||||
|
[key: string]: net.Socket[];
|
||||||
|
};
|
||||||
|
public requests: {
|
||||||
|
[key: string]: http.IncomingMessage[];
|
||||||
|
};
|
||||||
|
public options: https.AgentOptions;
|
||||||
|
private promisifiedCallback?: createAgent.AgentCallbackPromise;
|
||||||
|
private explicitDefaultPort?: number;
|
||||||
|
private explicitProtocol?: string;
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
callback?: createAgent.AgentCallback | createAgent.AgentOptions,
|
||||||
|
_opts?: createAgent.AgentOptions
|
||||||
|
) {
|
||||||
|
super();
|
||||||
|
|
||||||
|
let opts = _opts;
|
||||||
|
if (typeof callback === 'function') {
|
||||||
|
this.callback = callback;
|
||||||
|
} else if (callback) {
|
||||||
|
opts = callback;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Timeout for the socket to be returned from the callback
|
||||||
|
this.timeout = null;
|
||||||
|
if (opts && typeof opts.timeout === 'number') {
|
||||||
|
this.timeout = opts.timeout;
|
||||||
|
}
|
||||||
|
|
||||||
|
// These aren't actually used by `agent-base`, but are required
|
||||||
|
// for the TypeScript definition files in `@types/node` :/
|
||||||
|
this.maxFreeSockets = 1;
|
||||||
|
this.maxSockets = 1;
|
||||||
|
this.maxTotalSockets = Infinity;
|
||||||
|
this.sockets = {};
|
||||||
|
this.freeSockets = {};
|
||||||
|
this.requests = {};
|
||||||
|
this.options = {};
|
||||||
|
}
|
||||||
|
|
||||||
|
get defaultPort(): number {
|
||||||
|
if (typeof this.explicitDefaultPort === 'number') {
|
||||||
|
return this.explicitDefaultPort;
|
||||||
|
}
|
||||||
|
return isSecureEndpoint() ? 443 : 80;
|
||||||
|
}
|
||||||
|
|
||||||
|
set defaultPort(v: number) {
|
||||||
|
this.explicitDefaultPort = v;
|
||||||
|
}
|
||||||
|
|
||||||
|
get protocol(): string {
|
||||||
|
if (typeof this.explicitProtocol === 'string') {
|
||||||
|
return this.explicitProtocol;
|
||||||
|
}
|
||||||
|
return isSecureEndpoint() ? 'https:' : 'http:';
|
||||||
|
}
|
||||||
|
|
||||||
|
set protocol(v: string) {
|
||||||
|
this.explicitProtocol = v;
|
||||||
|
}
|
||||||
|
|
||||||
|
callback(
|
||||||
|
req: createAgent.ClientRequest,
|
||||||
|
opts: createAgent.RequestOptions,
|
||||||
|
fn: createAgent.AgentCallbackCallback
|
||||||
|
): void;
|
||||||
|
callback(
|
||||||
|
req: createAgent.ClientRequest,
|
||||||
|
opts: createAgent.RequestOptions
|
||||||
|
):
|
||||||
|
| createAgent.AgentCallbackReturn
|
||||||
|
| Promise<createAgent.AgentCallbackReturn>;
|
||||||
|
callback(
|
||||||
|
req: createAgent.ClientRequest,
|
||||||
|
opts: createAgent.AgentOptions,
|
||||||
|
fn?: createAgent.AgentCallbackCallback
|
||||||
|
):
|
||||||
|
| createAgent.AgentCallbackReturn
|
||||||
|
| Promise<createAgent.AgentCallbackReturn>
|
||||||
|
| void {
|
||||||
|
throw new Error(
|
||||||
|
'"agent-base" has no default implementation, you must subclass and override `callback()`'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Called by node-core's "_http_client.js" module when creating
|
||||||
|
* a new HTTP request with this Agent instance.
|
||||||
|
*
|
||||||
|
* @api public
|
||||||
|
*/
|
||||||
|
addRequest(req: ClientRequest, _opts: RequestOptions): void {
|
||||||
|
const opts: RequestOptions = { ..._opts };
|
||||||
|
|
||||||
|
if (typeof opts.secureEndpoint !== 'boolean') {
|
||||||
|
opts.secureEndpoint = isSecureEndpoint();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.host == null) {
|
||||||
|
opts.host = 'localhost';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.port == null) {
|
||||||
|
opts.port = opts.secureEndpoint ? 443 : 80;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.protocol == null) {
|
||||||
|
opts.protocol = opts.secureEndpoint ? 'https:' : 'http:';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.host && opts.path) {
|
||||||
|
// If both a `host` and `path` are specified then it's most
|
||||||
|
// likely the result of a `url.parse()` call... we need to
|
||||||
|
// remove the `path` portion so that `net.connect()` doesn't
|
||||||
|
// attempt to open that as a unix socket file.
|
||||||
|
delete opts.path;
|
||||||
|
}
|
||||||
|
|
||||||
|
delete opts.agent;
|
||||||
|
delete opts.hostname;
|
||||||
|
delete opts._defaultAgent;
|
||||||
|
delete opts.defaultPort;
|
||||||
|
delete opts.createConnection;
|
||||||
|
|
||||||
|
// Hint to use "Connection: close"
|
||||||
|
// XXX: non-documented `http` module API :(
|
||||||
|
req._last = true;
|
||||||
|
req.shouldKeepAlive = false;
|
||||||
|
|
||||||
|
let timedOut = false;
|
||||||
|
let timeoutId: ReturnType<typeof setTimeout> | null = null;
|
||||||
|
const timeoutMs = opts.timeout || this.timeout;
|
||||||
|
|
||||||
|
const onerror = (err: NodeJS.ErrnoException) => {
|
||||||
|
if (req._hadError) return;
|
||||||
|
req.emit('error', err);
|
||||||
|
// For Safety. Some additional errors might fire later on
|
||||||
|
// and we need to make sure we don't double-fire the error event.
|
||||||
|
req._hadError = true;
|
||||||
|
};
|
||||||
|
|
||||||
|
const ontimeout = () => {
|
||||||
|
timeoutId = null;
|
||||||
|
timedOut = true;
|
||||||
|
const err: NodeJS.ErrnoException = new Error(
|
||||||
|
`A "socket" was not created for HTTP request before ${timeoutMs}ms`
|
||||||
|
);
|
||||||
|
err.code = 'ETIMEOUT';
|
||||||
|
onerror(err);
|
||||||
|
};
|
||||||
|
|
||||||
|
const callbackError = (err: NodeJS.ErrnoException) => {
|
||||||
|
if (timedOut) return;
|
||||||
|
if (timeoutId !== null) {
|
||||||
|
clearTimeout(timeoutId);
|
||||||
|
timeoutId = null;
|
||||||
|
}
|
||||||
|
onerror(err);
|
||||||
|
};
|
||||||
|
|
||||||
|
const onsocket = (socket: AgentCallbackReturn) => {
|
||||||
|
if (timedOut) return;
|
||||||
|
if (timeoutId != null) {
|
||||||
|
clearTimeout(timeoutId);
|
||||||
|
timeoutId = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isAgent(socket)) {
|
||||||
|
// `socket` is actually an `http.Agent` instance, so
|
||||||
|
// relinquish responsibility for this `req` to the Agent
|
||||||
|
// from here on
|
||||||
|
debug(
|
||||||
|
'Callback returned another Agent instance %o',
|
||||||
|
socket.constructor.name
|
||||||
|
);
|
||||||
|
(socket as createAgent.Agent).addRequest(req, opts);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (socket) {
|
||||||
|
socket.once('free', () => {
|
||||||
|
this.freeSocket(socket as net.Socket, opts);
|
||||||
|
});
|
||||||
|
req.onSocket(socket as net.Socket);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const err = new Error(
|
||||||
|
`no Duplex stream was returned to agent-base for \`${req.method} ${req.path}\``
|
||||||
|
);
|
||||||
|
onerror(err);
|
||||||
|
};
|
||||||
|
|
||||||
|
if (typeof this.callback !== 'function') {
|
||||||
|
onerror(new Error('`callback` is not defined'));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!this.promisifiedCallback) {
|
||||||
|
if (this.callback.length >= 3) {
|
||||||
|
debug('Converting legacy callback function to promise');
|
||||||
|
this.promisifiedCallback = promisify(this.callback);
|
||||||
|
} else {
|
||||||
|
this.promisifiedCallback = this.callback;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof timeoutMs === 'number' && timeoutMs > 0) {
|
||||||
|
timeoutId = setTimeout(ontimeout, timeoutMs);
|
||||||
|
}
|
||||||
|
|
||||||
|
if ('port' in opts && typeof opts.port !== 'number') {
|
||||||
|
opts.port = Number(opts.port);
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
debug(
|
||||||
|
'Resolving socket for %o request: %o',
|
||||||
|
opts.protocol,
|
||||||
|
`${req.method} ${req.path}`
|
||||||
|
);
|
||||||
|
Promise.resolve(this.promisifiedCallback(req, opts)).then(
|
||||||
|
onsocket,
|
||||||
|
callbackError
|
||||||
|
);
|
||||||
|
} catch (err) {
|
||||||
|
Promise.reject(err).catch(callbackError);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
freeSocket(socket: net.Socket, opts: AgentOptions) {
|
||||||
|
debug('Freeing socket %o %o', socket.constructor.name, opts);
|
||||||
|
socket.destroy();
|
||||||
|
}
|
||||||
|
|
||||||
|
destroy() {
|
||||||
|
debug('Destroying agent %o', this.constructor.name);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// So that `instanceof` works correctly
|
||||||
|
createAgent.prototype = createAgent.Agent.prototype;
|
||||||
|
}
|
||||||
|
|
||||||
|
export = createAgent;
|
||||||
|
|
@ -0,0 +1,33 @@
|
||||||
|
import {
|
||||||
|
Agent,
|
||||||
|
ClientRequest,
|
||||||
|
RequestOptions,
|
||||||
|
AgentCallbackCallback,
|
||||||
|
AgentCallbackPromise,
|
||||||
|
AgentCallbackReturn
|
||||||
|
} from './index';
|
||||||
|
|
||||||
|
type LegacyCallback = (
|
||||||
|
req: ClientRequest,
|
||||||
|
opts: RequestOptions,
|
||||||
|
fn: AgentCallbackCallback
|
||||||
|
) => void;
|
||||||
|
|
||||||
|
export default function promisify(fn: LegacyCallback): AgentCallbackPromise {
|
||||||
|
return function(this: Agent, req: ClientRequest, opts: RequestOptions) {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
fn.call(
|
||||||
|
this,
|
||||||
|
req,
|
||||||
|
opts,
|
||||||
|
(err: Error | null | undefined, rtn?: AgentCallbackReturn) => {
|
||||||
|
if (err) {
|
||||||
|
reject(err);
|
||||||
|
} else {
|
||||||
|
resolve(rtn);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
);
|
||||||
|
});
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,15 @@
|
||||||
|
The ISC License
|
||||||
|
|
||||||
|
Copyright (c) 2019 Elan Shanker, Paul Miller (https://paulmillr.com)
|
||||||
|
|
||||||
|
Permission to use, copy, modify, and/or distribute this software for any
|
||||||
|
purpose with or without fee is hereby granted, provided that the above
|
||||||
|
copyright notice and this permission notice appear in all copies.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||||
|
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||||
|
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||||
|
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||||
|
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||||
|
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
|
||||||
|
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||||
|
|
@ -0,0 +1,87 @@
|
||||||
|
anymatch [](https://travis-ci.org/micromatch/anymatch) [](https://coveralls.io/r/micromatch/anymatch?branch=master)
|
||||||
|
======
|
||||||
|
Javascript module to match a string against a regular expression, glob, string,
|
||||||
|
or function that takes the string as an argument and returns a truthy or falsy
|
||||||
|
value. The matcher can also be an array of any or all of these. Useful for
|
||||||
|
allowing a very flexible user-defined config to define things like file paths.
|
||||||
|
|
||||||
|
__Note: This module has Bash-parity, please be aware that Windows-style backslashes are not supported as separators. See https://github.com/micromatch/micromatch#backslashes for more information.__
|
||||||
|
|
||||||
|
|
||||||
|
Usage
|
||||||
|
-----
|
||||||
|
```sh
|
||||||
|
npm install anymatch
|
||||||
|
```
|
||||||
|
|
||||||
|
#### anymatch(matchers, testString, [returnIndex], [options])
|
||||||
|
* __matchers__: (_Array|String|RegExp|Function_)
|
||||||
|
String to be directly matched, string with glob patterns, regular expression
|
||||||
|
test, function that takes the testString as an argument and returns a truthy
|
||||||
|
value if it should be matched, or an array of any number and mix of these types.
|
||||||
|
* __testString__: (_String|Array_) The string to test against the matchers. If
|
||||||
|
passed as an array, the first element of the array will be used as the
|
||||||
|
`testString` for non-function matchers, while the entire array will be applied
|
||||||
|
as the arguments for function matchers.
|
||||||
|
* __options__: (_Object_ [optional]_) Any of the [picomatch](https://github.com/micromatch/picomatch#options) options.
|
||||||
|
* __returnIndex__: (_Boolean [optional]_) If true, return the array index of
|
||||||
|
the first matcher that that testString matched, or -1 if no match, instead of a
|
||||||
|
boolean result.
|
||||||
|
|
||||||
|
```js
|
||||||
|
const anymatch = require('anymatch');
|
||||||
|
|
||||||
|
const matchers = [ 'path/to/file.js', 'path/anyjs/**/*.js', /foo.js$/, string => string.includes('bar') && string.length > 10 ] ;
|
||||||
|
|
||||||
|
anymatch(matchers, 'path/to/file.js'); // true
|
||||||
|
anymatch(matchers, 'path/anyjs/baz.js'); // true
|
||||||
|
anymatch(matchers, 'path/to/foo.js'); // true
|
||||||
|
anymatch(matchers, 'path/to/bar.js'); // true
|
||||||
|
anymatch(matchers, 'bar.js'); // false
|
||||||
|
|
||||||
|
// returnIndex = true
|
||||||
|
anymatch(matchers, 'foo.js', {returnIndex: true}); // 2
|
||||||
|
anymatch(matchers, 'path/anyjs/foo.js', {returnIndex: true}); // 1
|
||||||
|
|
||||||
|
// any picomatc
|
||||||
|
|
||||||
|
// using globs to match directories and their children
|
||||||
|
anymatch('node_modules', 'node_modules'); // true
|
||||||
|
anymatch('node_modules', 'node_modules/somelib/index.js'); // false
|
||||||
|
anymatch('node_modules/**', 'node_modules/somelib/index.js'); // true
|
||||||
|
anymatch('node_modules/**', '/absolute/path/to/node_modules/somelib/index.js'); // false
|
||||||
|
anymatch('**/node_modules/**', '/absolute/path/to/node_modules/somelib/index.js'); // true
|
||||||
|
|
||||||
|
const matcher = anymatch(matchers);
|
||||||
|
['foo.js', 'bar.js'].filter(matcher); // [ 'foo.js' ]
|
||||||
|
anymatch master* ❯
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
#### anymatch(matchers)
|
||||||
|
You can also pass in only your matcher(s) to get a curried function that has
|
||||||
|
already been bound to the provided matching criteria. This can be used as an
|
||||||
|
`Array#filter` callback.
|
||||||
|
|
||||||
|
```js
|
||||||
|
var matcher = anymatch(matchers);
|
||||||
|
|
||||||
|
matcher('path/to/file.js'); // true
|
||||||
|
matcher('path/anyjs/baz.js', true); // 1
|
||||||
|
|
||||||
|
['foo.js', 'bar.js'].filter(matcher); // ['foo.js']
|
||||||
|
```
|
||||||
|
|
||||||
|
Changelog
|
||||||
|
----------
|
||||||
|
[See release notes page on GitHub](https://github.com/micromatch/anymatch/releases)
|
||||||
|
|
||||||
|
- **v3.0:** Removed `startIndex` and `endIndex` arguments. Node 8.x-only.
|
||||||
|
- **v2.0:** [micromatch](https://github.com/jonschlinkert/micromatch) moves away from minimatch-parity and inline with Bash. This includes handling backslashes differently (see https://github.com/micromatch/micromatch#backslashes for more information).
|
||||||
|
- **v1.2:** anymatch uses [micromatch](https://github.com/jonschlinkert/micromatch)
|
||||||
|
for glob pattern matching. Issues with glob pattern matching should be
|
||||||
|
reported directly to the [micromatch issue tracker](https://github.com/jonschlinkert/micromatch/issues).
|
||||||
|
|
||||||
|
License
|
||||||
|
-------
|
||||||
|
[ISC](https://raw.github.com/micromatch/anymatch/master/LICENSE)
|
||||||
|
|
@ -0,0 +1,20 @@
|
||||||
|
type AnymatchFn = (testString: string) => boolean;
|
||||||
|
type AnymatchPattern = string|RegExp|AnymatchFn;
|
||||||
|
type AnymatchMatcher = AnymatchPattern|AnymatchPattern[]
|
||||||
|
type AnymatchTester = {
|
||||||
|
(testString: string|any[], returnIndex: true): number;
|
||||||
|
(testString: string|any[]): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
type PicomatchOptions = {dot: boolean};
|
||||||
|
|
||||||
|
declare const anymatch: {
|
||||||
|
(matchers: AnymatchMatcher): AnymatchTester;
|
||||||
|
(matchers: AnymatchMatcher, testString: null, returnIndex: true | PicomatchOptions): AnymatchTester;
|
||||||
|
(matchers: AnymatchMatcher, testString: string|any[], returnIndex: true | PicomatchOptions): number;
|
||||||
|
(matchers: AnymatchMatcher, testString: string|any[]): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export {AnymatchMatcher as Matcher}
|
||||||
|
export {AnymatchTester as Tester}
|
||||||
|
export default anymatch
|
||||||
|
|
@ -0,0 +1,104 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
Object.defineProperty(exports, "__esModule", { value: true });
|
||||||
|
|
||||||
|
const picomatch = require('picomatch');
|
||||||
|
const normalizePath = require('normalize-path');
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @typedef {(testString: string) => boolean} AnymatchFn
|
||||||
|
* @typedef {string|RegExp|AnymatchFn} AnymatchPattern
|
||||||
|
* @typedef {AnymatchPattern|AnymatchPattern[]} AnymatchMatcher
|
||||||
|
*/
|
||||||
|
const BANG = '!';
|
||||||
|
const DEFAULT_OPTIONS = {returnIndex: false};
|
||||||
|
const arrify = (item) => Array.isArray(item) ? item : [item];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {AnymatchPattern} matcher
|
||||||
|
* @param {object} options
|
||||||
|
* @returns {AnymatchFn}
|
||||||
|
*/
|
||||||
|
const createPattern = (matcher, options) => {
|
||||||
|
if (typeof matcher === 'function') {
|
||||||
|
return matcher;
|
||||||
|
}
|
||||||
|
if (typeof matcher === 'string') {
|
||||||
|
const glob = picomatch(matcher, options);
|
||||||
|
return (string) => matcher === string || glob(string);
|
||||||
|
}
|
||||||
|
if (matcher instanceof RegExp) {
|
||||||
|
return (string) => matcher.test(string);
|
||||||
|
}
|
||||||
|
return (string) => false;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {Array<Function>} patterns
|
||||||
|
* @param {Array<Function>} negPatterns
|
||||||
|
* @param {String|Array} args
|
||||||
|
* @param {Boolean} returnIndex
|
||||||
|
* @returns {boolean|number}
|
||||||
|
*/
|
||||||
|
const matchPatterns = (patterns, negPatterns, args, returnIndex) => {
|
||||||
|
const isList = Array.isArray(args);
|
||||||
|
const _path = isList ? args[0] : args;
|
||||||
|
if (!isList && typeof _path !== 'string') {
|
||||||
|
throw new TypeError('anymatch: second argument must be a string: got ' +
|
||||||
|
Object.prototype.toString.call(_path))
|
||||||
|
}
|
||||||
|
const path = normalizePath(_path, false);
|
||||||
|
|
||||||
|
for (let index = 0; index < negPatterns.length; index++) {
|
||||||
|
const nglob = negPatterns[index];
|
||||||
|
if (nglob(path)) {
|
||||||
|
return returnIndex ? -1 : false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const applied = isList && [path].concat(args.slice(1));
|
||||||
|
for (let index = 0; index < patterns.length; index++) {
|
||||||
|
const pattern = patterns[index];
|
||||||
|
if (isList ? pattern(...applied) : pattern(path)) {
|
||||||
|
return returnIndex ? index : true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return returnIndex ? -1 : false;
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @param {AnymatchMatcher} matchers
|
||||||
|
* @param {Array|string} testString
|
||||||
|
* @param {object} options
|
||||||
|
* @returns {boolean|number|Function}
|
||||||
|
*/
|
||||||
|
const anymatch = (matchers, testString, options = DEFAULT_OPTIONS) => {
|
||||||
|
if (matchers == null) {
|
||||||
|
throw new TypeError('anymatch: specify first argument');
|
||||||
|
}
|
||||||
|
const opts = typeof options === 'boolean' ? {returnIndex: options} : options;
|
||||||
|
const returnIndex = opts.returnIndex || false;
|
||||||
|
|
||||||
|
// Early cache for matchers.
|
||||||
|
const mtchers = arrify(matchers);
|
||||||
|
const negatedGlobs = mtchers
|
||||||
|
.filter(item => typeof item === 'string' && item.charAt(0) === BANG)
|
||||||
|
.map(item => item.slice(1))
|
||||||
|
.map(item => picomatch(item, opts));
|
||||||
|
const patterns = mtchers
|
||||||
|
.filter(item => typeof item !== 'string' || (typeof item === 'string' && item.charAt(0) !== BANG))
|
||||||
|
.map(matcher => createPattern(matcher, opts));
|
||||||
|
|
||||||
|
if (testString == null) {
|
||||||
|
return (testString, ri = false) => {
|
||||||
|
const returnIndex = typeof ri === 'boolean' ? ri : false;
|
||||||
|
return matchPatterns(patterns, negatedGlobs, testString, returnIndex);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return matchPatterns(patterns, negatedGlobs, testString, returnIndex);
|
||||||
|
};
|
||||||
|
|
||||||
|
anymatch.default = anymatch;
|
||||||
|
module.exports = anymatch;
|
||||||
|
|
@ -0,0 +1,48 @@
|
||||||
|
{
|
||||||
|
"name": "anymatch",
|
||||||
|
"version": "3.1.3",
|
||||||
|
"description": "Matches strings against configurable strings, globs, regular expressions, and/or functions",
|
||||||
|
"files": [
|
||||||
|
"index.js",
|
||||||
|
"index.d.ts"
|
||||||
|
],
|
||||||
|
"dependencies": {
|
||||||
|
"normalize-path": "^3.0.0",
|
||||||
|
"picomatch": "^2.0.4"
|
||||||
|
},
|
||||||
|
"author": {
|
||||||
|
"name": "Elan Shanker",
|
||||||
|
"url": "https://github.com/es128"
|
||||||
|
},
|
||||||
|
"license": "ISC",
|
||||||
|
"homepage": "https://github.com/micromatch/anymatch",
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "https://github.com/micromatch/anymatch"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"match",
|
||||||
|
"any",
|
||||||
|
"string",
|
||||||
|
"file",
|
||||||
|
"fs",
|
||||||
|
"list",
|
||||||
|
"glob",
|
||||||
|
"regex",
|
||||||
|
"regexp",
|
||||||
|
"regular",
|
||||||
|
"expression",
|
||||||
|
"function"
|
||||||
|
],
|
||||||
|
"scripts": {
|
||||||
|
"test": "nyc mocha",
|
||||||
|
"mocha": "mocha"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"mocha": "^6.1.3",
|
||||||
|
"nyc": "^14.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 8"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2016 Alex Indigo
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
|
|
@ -0,0 +1,233 @@
|
||||||
|
# asynckit [](https://www.npmjs.com/package/asynckit)
|
||||||
|
|
||||||
|
Minimal async jobs utility library, with streams support.
|
||||||
|
|
||||||
|
[](https://travis-ci.org/alexindigo/asynckit)
|
||||||
|
[](https://travis-ci.org/alexindigo/asynckit)
|
||||||
|
[](https://ci.appveyor.com/project/alexindigo/asynckit)
|
||||||
|
|
||||||
|
[](https://coveralls.io/github/alexindigo/asynckit?branch=master)
|
||||||
|
[](https://david-dm.org/alexindigo/asynckit)
|
||||||
|
[](https://www.bithound.io/github/alexindigo/asynckit)
|
||||||
|
|
||||||
|
<!-- [](https://www.npmjs.com/package/reamde) -->
|
||||||
|
|
||||||
|
AsyncKit provides harness for `parallel` and `serial` iterators over list of items represented by arrays or objects.
|
||||||
|
Optionally it accepts abort function (should be synchronously return by iterator for each item), and terminates left over jobs upon an error event. For specific iteration order built-in (`ascending` and `descending`) and custom sort helpers also supported, via `asynckit.serialOrdered` method.
|
||||||
|
|
||||||
|
It ensures async operations to keep behavior more stable and prevent `Maximum call stack size exceeded` errors, from sync iterators.
|
||||||
|
|
||||||
|
| compression | size |
|
||||||
|
| :----------------- | -------: |
|
||||||
|
| asynckit.js | 12.34 kB |
|
||||||
|
| asynckit.min.js | 4.11 kB |
|
||||||
|
| asynckit.min.js.gz | 1.47 kB |
|
||||||
|
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ npm install --save asynckit
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
### Parallel Jobs
|
||||||
|
|
||||||
|
Runs iterator over provided array in parallel. Stores output in the `result` array,
|
||||||
|
on the matching positions. In unlikely event of an error from one of the jobs,
|
||||||
|
will terminate rest of the active jobs (if abort function is provided)
|
||||||
|
and return error along with salvaged data to the main callback function.
|
||||||
|
|
||||||
|
#### Input Array
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var parallel = require('asynckit').parallel
|
||||||
|
, assert = require('assert')
|
||||||
|
;
|
||||||
|
|
||||||
|
var source = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
|
||||||
|
, expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
|
||||||
|
, expectedTarget = [ 1, 1, 2, 4, 8, 16, 32, 64 ]
|
||||||
|
, target = []
|
||||||
|
;
|
||||||
|
|
||||||
|
parallel(source, asyncJob, function(err, result)
|
||||||
|
{
|
||||||
|
assert.deepEqual(result, expectedResult);
|
||||||
|
assert.deepEqual(target, expectedTarget);
|
||||||
|
});
|
||||||
|
|
||||||
|
// async job accepts one element from the array
|
||||||
|
// and a callback function
|
||||||
|
function asyncJob(item, cb)
|
||||||
|
{
|
||||||
|
// different delays (in ms) per item
|
||||||
|
var delay = item * 25;
|
||||||
|
|
||||||
|
// pretend different jobs take different time to finish
|
||||||
|
// and not in consequential order
|
||||||
|
var timeoutId = setTimeout(function() {
|
||||||
|
target.push(item);
|
||||||
|
cb(null, item * 2);
|
||||||
|
}, delay);
|
||||||
|
|
||||||
|
// allow to cancel "leftover" jobs upon error
|
||||||
|
// return function, invoking of which will abort this job
|
||||||
|
return clearTimeout.bind(null, timeoutId);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
More examples could be found in [test/test-parallel-array.js](test/test-parallel-array.js).
|
||||||
|
|
||||||
|
#### Input Object
|
||||||
|
|
||||||
|
Also it supports named jobs, listed via object.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var parallel = require('asynckit/parallel')
|
||||||
|
, assert = require('assert')
|
||||||
|
;
|
||||||
|
|
||||||
|
var source = { first: 1, one: 1, four: 4, sixteen: 16, sixtyFour: 64, thirtyTwo: 32, eight: 8, two: 2 }
|
||||||
|
, expectedResult = { first: 2, one: 2, four: 8, sixteen: 32, sixtyFour: 128, thirtyTwo: 64, eight: 16, two: 4 }
|
||||||
|
, expectedTarget = [ 1, 1, 2, 4, 8, 16, 32, 64 ]
|
||||||
|
, expectedKeys = [ 'first', 'one', 'two', 'four', 'eight', 'sixteen', 'thirtyTwo', 'sixtyFour' ]
|
||||||
|
, target = []
|
||||||
|
, keys = []
|
||||||
|
;
|
||||||
|
|
||||||
|
parallel(source, asyncJob, function(err, result)
|
||||||
|
{
|
||||||
|
assert.deepEqual(result, expectedResult);
|
||||||
|
assert.deepEqual(target, expectedTarget);
|
||||||
|
assert.deepEqual(keys, expectedKeys);
|
||||||
|
});
|
||||||
|
|
||||||
|
// supports full value, key, callback (shortcut) interface
|
||||||
|
function asyncJob(item, key, cb)
|
||||||
|
{
|
||||||
|
// different delays (in ms) per item
|
||||||
|
var delay = item * 25;
|
||||||
|
|
||||||
|
// pretend different jobs take different time to finish
|
||||||
|
// and not in consequential order
|
||||||
|
var timeoutId = setTimeout(function() {
|
||||||
|
keys.push(key);
|
||||||
|
target.push(item);
|
||||||
|
cb(null, item * 2);
|
||||||
|
}, delay);
|
||||||
|
|
||||||
|
// allow to cancel "leftover" jobs upon error
|
||||||
|
// return function, invoking of which will abort this job
|
||||||
|
return clearTimeout.bind(null, timeoutId);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
More examples could be found in [test/test-parallel-object.js](test/test-parallel-object.js).
|
||||||
|
|
||||||
|
### Serial Jobs
|
||||||
|
|
||||||
|
Runs iterator over provided array sequentially. Stores output in the `result` array,
|
||||||
|
on the matching positions. In unlikely event of an error from one of the jobs,
|
||||||
|
will not proceed to the rest of the items in the list
|
||||||
|
and return error along with salvaged data to the main callback function.
|
||||||
|
|
||||||
|
#### Input Array
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var serial = require('asynckit/serial')
|
||||||
|
, assert = require('assert')
|
||||||
|
;
|
||||||
|
|
||||||
|
var source = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
|
||||||
|
, expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
|
||||||
|
, expectedTarget = [ 0, 1, 2, 3, 4, 5, 6, 7 ]
|
||||||
|
, target = []
|
||||||
|
;
|
||||||
|
|
||||||
|
serial(source, asyncJob, function(err, result)
|
||||||
|
{
|
||||||
|
assert.deepEqual(result, expectedResult);
|
||||||
|
assert.deepEqual(target, expectedTarget);
|
||||||
|
});
|
||||||
|
|
||||||
|
// extended interface (item, key, callback)
|
||||||
|
// also supported for arrays
|
||||||
|
function asyncJob(item, key, cb)
|
||||||
|
{
|
||||||
|
target.push(key);
|
||||||
|
|
||||||
|
// it will be automatically made async
|
||||||
|
// even it iterator "returns" in the same event loop
|
||||||
|
cb(null, item * 2);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
More examples could be found in [test/test-serial-array.js](test/test-serial-array.js).
|
||||||
|
|
||||||
|
#### Input Object
|
||||||
|
|
||||||
|
Also it supports named jobs, listed via object.
|
||||||
|
|
||||||
|
```javascript
|
||||||
|
var serial = require('asynckit').serial
|
||||||
|
, assert = require('assert')
|
||||||
|
;
|
||||||
|
|
||||||
|
var source = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
|
||||||
|
, expectedResult = [ 2, 2, 8, 32, 128, 64, 16, 4 ]
|
||||||
|
, expectedTarget = [ 0, 1, 2, 3, 4, 5, 6, 7 ]
|
||||||
|
, target = []
|
||||||
|
;
|
||||||
|
|
||||||
|
var source = { first: 1, one: 1, four: 4, sixteen: 16, sixtyFour: 64, thirtyTwo: 32, eight: 8, two: 2 }
|
||||||
|
, expectedResult = { first: 2, one: 2, four: 8, sixteen: 32, sixtyFour: 128, thirtyTwo: 64, eight: 16, two: 4 }
|
||||||
|
, expectedTarget = [ 1, 1, 4, 16, 64, 32, 8, 2 ]
|
||||||
|
, target = []
|
||||||
|
;
|
||||||
|
|
||||||
|
|
||||||
|
serial(source, asyncJob, function(err, result)
|
||||||
|
{
|
||||||
|
assert.deepEqual(result, expectedResult);
|
||||||
|
assert.deepEqual(target, expectedTarget);
|
||||||
|
});
|
||||||
|
|
||||||
|
// shortcut interface (item, callback)
|
||||||
|
// works for object as well as for the arrays
|
||||||
|
function asyncJob(item, cb)
|
||||||
|
{
|
||||||
|
target.push(item);
|
||||||
|
|
||||||
|
// it will be automatically made async
|
||||||
|
// even it iterator "returns" in the same event loop
|
||||||
|
cb(null, item * 2);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
More examples could be found in [test/test-serial-object.js](test/test-serial-object.js).
|
||||||
|
|
||||||
|
_Note: Since _object_ is an _unordered_ collection of properties,
|
||||||
|
it may produce unexpected results with sequential iterations.
|
||||||
|
Whenever order of the jobs' execution is important please use `serialOrdered` method._
|
||||||
|
|
||||||
|
### Ordered Serial Iterations
|
||||||
|
|
||||||
|
TBD
|
||||||
|
|
||||||
|
For example [compare-property](compare-property) package.
|
||||||
|
|
||||||
|
### Streaming interface
|
||||||
|
|
||||||
|
TBD
|
||||||
|
|
||||||
|
## Want to Know More?
|
||||||
|
|
||||||
|
More examples can be found in [test folder](test/).
|
||||||
|
|
||||||
|
Or open an [issue](https://github.com/alexindigo/asynckit/issues) with questions and/or suggestions.
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
AsyncKit is licensed under the MIT license.
|
||||||
|
|
@ -0,0 +1,76 @@
|
||||||
|
/* eslint no-console: "off" */
|
||||||
|
|
||||||
|
var asynckit = require('./')
|
||||||
|
, async = require('async')
|
||||||
|
, assert = require('assert')
|
||||||
|
, expected = 0
|
||||||
|
;
|
||||||
|
|
||||||
|
var Benchmark = require('benchmark');
|
||||||
|
var suite = new Benchmark.Suite;
|
||||||
|
|
||||||
|
var source = [];
|
||||||
|
for (var z = 1; z < 100; z++)
|
||||||
|
{
|
||||||
|
source.push(z);
|
||||||
|
expected += z;
|
||||||
|
}
|
||||||
|
|
||||||
|
suite
|
||||||
|
// add tests
|
||||||
|
|
||||||
|
.add('async.map', function(deferred)
|
||||||
|
{
|
||||||
|
var total = 0;
|
||||||
|
|
||||||
|
async.map(source,
|
||||||
|
function(i, cb)
|
||||||
|
{
|
||||||
|
setImmediate(function()
|
||||||
|
{
|
||||||
|
total += i;
|
||||||
|
cb(null, total);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
function(err, result)
|
||||||
|
{
|
||||||
|
assert.ifError(err);
|
||||||
|
assert.equal(result[result.length - 1], expected);
|
||||||
|
deferred.resolve();
|
||||||
|
});
|
||||||
|
}, {'defer': true})
|
||||||
|
|
||||||
|
|
||||||
|
.add('asynckit.parallel', function(deferred)
|
||||||
|
{
|
||||||
|
var total = 0;
|
||||||
|
|
||||||
|
asynckit.parallel(source,
|
||||||
|
function(i, cb)
|
||||||
|
{
|
||||||
|
setImmediate(function()
|
||||||
|
{
|
||||||
|
total += i;
|
||||||
|
cb(null, total);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
function(err, result)
|
||||||
|
{
|
||||||
|
assert.ifError(err);
|
||||||
|
assert.equal(result[result.length - 1], expected);
|
||||||
|
deferred.resolve();
|
||||||
|
});
|
||||||
|
}, {'defer': true})
|
||||||
|
|
||||||
|
|
||||||
|
// add listeners
|
||||||
|
.on('cycle', function(ev)
|
||||||
|
{
|
||||||
|
console.log(String(ev.target));
|
||||||
|
})
|
||||||
|
.on('complete', function()
|
||||||
|
{
|
||||||
|
console.log('Fastest is ' + this.filter('fastest').map('name'));
|
||||||
|
})
|
||||||
|
// run async
|
||||||
|
.run({ 'async': true });
|
||||||
|
|
@ -0,0 +1,6 @@
|
||||||
|
module.exports =
|
||||||
|
{
|
||||||
|
parallel : require('./parallel.js'),
|
||||||
|
serial : require('./serial.js'),
|
||||||
|
serialOrdered : require('./serialOrdered.js')
|
||||||
|
};
|
||||||
|
|
@ -0,0 +1,29 @@
|
||||||
|
// API
|
||||||
|
module.exports = abort;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Aborts leftover active jobs
|
||||||
|
*
|
||||||
|
* @param {object} state - current state object
|
||||||
|
*/
|
||||||
|
function abort(state)
|
||||||
|
{
|
||||||
|
Object.keys(state.jobs).forEach(clean.bind(state));
|
||||||
|
|
||||||
|
// reset leftover jobs
|
||||||
|
state.jobs = {};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Cleans up leftover job by invoking abort function for the provided job id
|
||||||
|
*
|
||||||
|
* @this state
|
||||||
|
* @param {string|number} key - job id to abort
|
||||||
|
*/
|
||||||
|
function clean(key)
|
||||||
|
{
|
||||||
|
if (typeof this.jobs[key] == 'function')
|
||||||
|
{
|
||||||
|
this.jobs[key]();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,34 @@
|
||||||
|
var defer = require('./defer.js');
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports = async;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs provided callback asynchronously
|
||||||
|
* even if callback itself is not
|
||||||
|
*
|
||||||
|
* @param {function} callback - callback to invoke
|
||||||
|
* @returns {function} - augmented callback
|
||||||
|
*/
|
||||||
|
function async(callback)
|
||||||
|
{
|
||||||
|
var isAsync = false;
|
||||||
|
|
||||||
|
// check if async happened
|
||||||
|
defer(function() { isAsync = true; });
|
||||||
|
|
||||||
|
return function async_callback(err, result)
|
||||||
|
{
|
||||||
|
if (isAsync)
|
||||||
|
{
|
||||||
|
callback(err, result);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
defer(function nextTick_callback()
|
||||||
|
{
|
||||||
|
callback(err, result);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,26 @@
|
||||||
|
module.exports = defer;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs provided function on next iteration of the event loop
|
||||||
|
*
|
||||||
|
* @param {function} fn - function to run
|
||||||
|
*/
|
||||||
|
function defer(fn)
|
||||||
|
{
|
||||||
|
var nextTick = typeof setImmediate == 'function'
|
||||||
|
? setImmediate
|
||||||
|
: (
|
||||||
|
typeof process == 'object' && typeof process.nextTick == 'function'
|
||||||
|
? process.nextTick
|
||||||
|
: null
|
||||||
|
);
|
||||||
|
|
||||||
|
if (nextTick)
|
||||||
|
{
|
||||||
|
nextTick(fn);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
setTimeout(fn, 0);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,75 @@
|
||||||
|
var async = require('./async.js')
|
||||||
|
, abort = require('./abort.js')
|
||||||
|
;
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports = iterate;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Iterates over each job object
|
||||||
|
*
|
||||||
|
* @param {array|object} list - array or object (named list) to iterate over
|
||||||
|
* @param {function} iterator - iterator to run
|
||||||
|
* @param {object} state - current job status
|
||||||
|
* @param {function} callback - invoked when all elements processed
|
||||||
|
*/
|
||||||
|
function iterate(list, iterator, state, callback)
|
||||||
|
{
|
||||||
|
// store current index
|
||||||
|
var key = state['keyedList'] ? state['keyedList'][state.index] : state.index;
|
||||||
|
|
||||||
|
state.jobs[key] = runJob(iterator, key, list[key], function(error, output)
|
||||||
|
{
|
||||||
|
// don't repeat yourself
|
||||||
|
// skip secondary callbacks
|
||||||
|
if (!(key in state.jobs))
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// clean up jobs
|
||||||
|
delete state.jobs[key];
|
||||||
|
|
||||||
|
if (error)
|
||||||
|
{
|
||||||
|
// don't process rest of the results
|
||||||
|
// stop still active jobs
|
||||||
|
// and reset the list
|
||||||
|
abort(state);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
state.results[key] = output;
|
||||||
|
}
|
||||||
|
|
||||||
|
// return salvaged results
|
||||||
|
callback(error, state.results);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs iterator over provided job element
|
||||||
|
*
|
||||||
|
* @param {function} iterator - iterator to invoke
|
||||||
|
* @param {string|number} key - key/index of the element in the list of jobs
|
||||||
|
* @param {mixed} item - job description
|
||||||
|
* @param {function} callback - invoked after iterator is done with the job
|
||||||
|
* @returns {function|mixed} - job abort function or something else
|
||||||
|
*/
|
||||||
|
function runJob(iterator, key, item, callback)
|
||||||
|
{
|
||||||
|
var aborter;
|
||||||
|
|
||||||
|
// allow shortcut if iterator expects only two arguments
|
||||||
|
if (iterator.length == 2)
|
||||||
|
{
|
||||||
|
aborter = iterator(item, async(callback));
|
||||||
|
}
|
||||||
|
// otherwise go with full three arguments
|
||||||
|
else
|
||||||
|
{
|
||||||
|
aborter = iterator(item, key, async(callback));
|
||||||
|
}
|
||||||
|
|
||||||
|
return aborter;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,91 @@
|
||||||
|
var streamify = require('./streamify.js')
|
||||||
|
, defer = require('./defer.js')
|
||||||
|
;
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports = ReadableAsyncKit;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Base constructor for all streams
|
||||||
|
* used to hold properties/methods
|
||||||
|
*/
|
||||||
|
function ReadableAsyncKit()
|
||||||
|
{
|
||||||
|
ReadableAsyncKit.super_.apply(this, arguments);
|
||||||
|
|
||||||
|
// list of active jobs
|
||||||
|
this.jobs = {};
|
||||||
|
|
||||||
|
// add stream methods
|
||||||
|
this.destroy = destroy;
|
||||||
|
this._start = _start;
|
||||||
|
this._read = _read;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Destroys readable stream,
|
||||||
|
* by aborting outstanding jobs
|
||||||
|
*
|
||||||
|
* @returns {void}
|
||||||
|
*/
|
||||||
|
function destroy()
|
||||||
|
{
|
||||||
|
if (this.destroyed)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.destroyed = true;
|
||||||
|
|
||||||
|
if (typeof this.terminator == 'function')
|
||||||
|
{
|
||||||
|
this.terminator();
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Starts provided jobs in async manner
|
||||||
|
*
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
function _start()
|
||||||
|
{
|
||||||
|
// first argument – runner function
|
||||||
|
var runner = arguments[0]
|
||||||
|
// take away first argument
|
||||||
|
, args = Array.prototype.slice.call(arguments, 1)
|
||||||
|
// second argument - input data
|
||||||
|
, input = args[0]
|
||||||
|
// last argument - result callback
|
||||||
|
, endCb = streamify.callback.call(this, args[args.length - 1])
|
||||||
|
;
|
||||||
|
|
||||||
|
args[args.length - 1] = endCb;
|
||||||
|
// third argument - iterator
|
||||||
|
args[1] = streamify.iterator.call(this, args[1]);
|
||||||
|
|
||||||
|
// allow time for proper setup
|
||||||
|
defer(function()
|
||||||
|
{
|
||||||
|
if (!this.destroyed)
|
||||||
|
{
|
||||||
|
this.terminator = runner.apply(null, args);
|
||||||
|
}
|
||||||
|
else
|
||||||
|
{
|
||||||
|
endCb(null, Array.isArray(input) ? [] : {});
|
||||||
|
}
|
||||||
|
}.bind(this));
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Implement _read to comply with Readable streams
|
||||||
|
* Doesn't really make sense for flowing object mode
|
||||||
|
*
|
||||||
|
* @private
|
||||||
|
*/
|
||||||
|
function _read()
|
||||||
|
{
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
var parallel = require('../parallel.js');
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports = ReadableParallel;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Streaming wrapper to `asynckit.parallel`
|
||||||
|
*
|
||||||
|
* @param {array|object} list - array or object (named list) to iterate over
|
||||||
|
* @param {function} iterator - iterator to run
|
||||||
|
* @param {function} callback - invoked when all elements processed
|
||||||
|
* @returns {stream.Readable#}
|
||||||
|
*/
|
||||||
|
function ReadableParallel(list, iterator, callback)
|
||||||
|
{
|
||||||
|
if (!(this instanceof ReadableParallel))
|
||||||
|
{
|
||||||
|
return new ReadableParallel(list, iterator, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
// turn on object mode
|
||||||
|
ReadableParallel.super_.call(this, {objectMode: true});
|
||||||
|
|
||||||
|
this._start(parallel, list, iterator, callback);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
var serial = require('../serial.js');
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports = ReadableSerial;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Streaming wrapper to `asynckit.serial`
|
||||||
|
*
|
||||||
|
* @param {array|object} list - array or object (named list) to iterate over
|
||||||
|
* @param {function} iterator - iterator to run
|
||||||
|
* @param {function} callback - invoked when all elements processed
|
||||||
|
* @returns {stream.Readable#}
|
||||||
|
*/
|
||||||
|
function ReadableSerial(list, iterator, callback)
|
||||||
|
{
|
||||||
|
if (!(this instanceof ReadableSerial))
|
||||||
|
{
|
||||||
|
return new ReadableSerial(list, iterator, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
// turn on object mode
|
||||||
|
ReadableSerial.super_.call(this, {objectMode: true});
|
||||||
|
|
||||||
|
this._start(serial, list, iterator, callback);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,29 @@
|
||||||
|
var serialOrdered = require('../serialOrdered.js');
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports = ReadableSerialOrdered;
|
||||||
|
// expose sort helpers
|
||||||
|
module.exports.ascending = serialOrdered.ascending;
|
||||||
|
module.exports.descending = serialOrdered.descending;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Streaming wrapper to `asynckit.serialOrdered`
|
||||||
|
*
|
||||||
|
* @param {array|object} list - array or object (named list) to iterate over
|
||||||
|
* @param {function} iterator - iterator to run
|
||||||
|
* @param {function} sortMethod - custom sort function
|
||||||
|
* @param {function} callback - invoked when all elements processed
|
||||||
|
* @returns {stream.Readable#}
|
||||||
|
*/
|
||||||
|
function ReadableSerialOrdered(list, iterator, sortMethod, callback)
|
||||||
|
{
|
||||||
|
if (!(this instanceof ReadableSerialOrdered))
|
||||||
|
{
|
||||||
|
return new ReadableSerialOrdered(list, iterator, sortMethod, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
// turn on object mode
|
||||||
|
ReadableSerialOrdered.super_.call(this, {objectMode: true});
|
||||||
|
|
||||||
|
this._start(serialOrdered, list, iterator, sortMethod, callback);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
// API
|
||||||
|
module.exports = state;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates initial state object
|
||||||
|
* for iteration over list
|
||||||
|
*
|
||||||
|
* @param {array|object} list - list to iterate over
|
||||||
|
* @param {function|null} sortMethod - function to use for keys sort,
|
||||||
|
* or `null` to keep them as is
|
||||||
|
* @returns {object} - initial state object
|
||||||
|
*/
|
||||||
|
function state(list, sortMethod)
|
||||||
|
{
|
||||||
|
var isNamedList = !Array.isArray(list)
|
||||||
|
, initState =
|
||||||
|
{
|
||||||
|
index : 0,
|
||||||
|
keyedList: isNamedList || sortMethod ? Object.keys(list) : null,
|
||||||
|
jobs : {},
|
||||||
|
results : isNamedList ? {} : [],
|
||||||
|
size : isNamedList ? Object.keys(list).length : list.length
|
||||||
|
}
|
||||||
|
;
|
||||||
|
|
||||||
|
if (sortMethod)
|
||||||
|
{
|
||||||
|
// sort array keys based on it's values
|
||||||
|
// sort object's keys just on own merit
|
||||||
|
initState.keyedList.sort(isNamedList ? sortMethod : function(a, b)
|
||||||
|
{
|
||||||
|
return sortMethod(list[a], list[b]);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
return initState;
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,141 @@
|
||||||
|
var async = require('./async.js');
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports = {
|
||||||
|
iterator: wrapIterator,
|
||||||
|
callback: wrapCallback
|
||||||
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wraps iterators with long signature
|
||||||
|
*
|
||||||
|
* @this ReadableAsyncKit#
|
||||||
|
* @param {function} iterator - function to wrap
|
||||||
|
* @returns {function} - wrapped function
|
||||||
|
*/
|
||||||
|
function wrapIterator(iterator)
|
||||||
|
{
|
||||||
|
var stream = this;
|
||||||
|
|
||||||
|
return function(item, key, cb)
|
||||||
|
{
|
||||||
|
var aborter
|
||||||
|
, wrappedCb = async(wrapIteratorCallback.call(stream, cb, key))
|
||||||
|
;
|
||||||
|
|
||||||
|
stream.jobs[key] = wrappedCb;
|
||||||
|
|
||||||
|
// it's either shortcut (item, cb)
|
||||||
|
if (iterator.length == 2)
|
||||||
|
{
|
||||||
|
aborter = iterator(item, wrappedCb);
|
||||||
|
}
|
||||||
|
// or long format (item, key, cb)
|
||||||
|
else
|
||||||
|
{
|
||||||
|
aborter = iterator(item, key, wrappedCb);
|
||||||
|
}
|
||||||
|
|
||||||
|
return aborter;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wraps provided callback function
|
||||||
|
* allowing to execute snitch function before
|
||||||
|
* real callback
|
||||||
|
*
|
||||||
|
* @this ReadableAsyncKit#
|
||||||
|
* @param {function} callback - function to wrap
|
||||||
|
* @returns {function} - wrapped function
|
||||||
|
*/
|
||||||
|
function wrapCallback(callback)
|
||||||
|
{
|
||||||
|
var stream = this;
|
||||||
|
|
||||||
|
var wrapped = function(error, result)
|
||||||
|
{
|
||||||
|
return finisher.call(stream, error, result, callback);
|
||||||
|
};
|
||||||
|
|
||||||
|
return wrapped;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wraps provided iterator callback function
|
||||||
|
* makes sure snitch only called once,
|
||||||
|
* but passes secondary calls to the original callback
|
||||||
|
*
|
||||||
|
* @this ReadableAsyncKit#
|
||||||
|
* @param {function} callback - callback to wrap
|
||||||
|
* @param {number|string} key - iteration key
|
||||||
|
* @returns {function} wrapped callback
|
||||||
|
*/
|
||||||
|
function wrapIteratorCallback(callback, key)
|
||||||
|
{
|
||||||
|
var stream = this;
|
||||||
|
|
||||||
|
return function(error, output)
|
||||||
|
{
|
||||||
|
// don't repeat yourself
|
||||||
|
if (!(key in stream.jobs))
|
||||||
|
{
|
||||||
|
callback(error, output);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// clean up jobs
|
||||||
|
delete stream.jobs[key];
|
||||||
|
|
||||||
|
return streamer.call(stream, error, {key: key, value: output}, callback);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stream wrapper for iterator callback
|
||||||
|
*
|
||||||
|
* @this ReadableAsyncKit#
|
||||||
|
* @param {mixed} error - error response
|
||||||
|
* @param {mixed} output - iterator output
|
||||||
|
* @param {function} callback - callback that expects iterator results
|
||||||
|
*/
|
||||||
|
function streamer(error, output, callback)
|
||||||
|
{
|
||||||
|
if (error && !this.error)
|
||||||
|
{
|
||||||
|
this.error = error;
|
||||||
|
this.pause();
|
||||||
|
this.emit('error', error);
|
||||||
|
// send back value only, as expected
|
||||||
|
callback(error, output && output.value);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// stream stuff
|
||||||
|
this.push(output);
|
||||||
|
|
||||||
|
// back to original track
|
||||||
|
// send back value only, as expected
|
||||||
|
callback(error, output && output.value);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Stream wrapper for finishing callback
|
||||||
|
*
|
||||||
|
* @this ReadableAsyncKit#
|
||||||
|
* @param {mixed} error - error response
|
||||||
|
* @param {mixed} output - iterator output
|
||||||
|
* @param {function} callback - callback that expects final results
|
||||||
|
*/
|
||||||
|
function finisher(error, output, callback)
|
||||||
|
{
|
||||||
|
// signal end of the stream
|
||||||
|
// only for successfully finished streams
|
||||||
|
if (!error)
|
||||||
|
{
|
||||||
|
this.push(null);
|
||||||
|
}
|
||||||
|
|
||||||
|
// back to original track
|
||||||
|
callback(error, output);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,29 @@
|
||||||
|
var abort = require('./abort.js')
|
||||||
|
, async = require('./async.js')
|
||||||
|
;
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports = terminator;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Terminates jobs in the attached state context
|
||||||
|
*
|
||||||
|
* @this AsyncKitState#
|
||||||
|
* @param {function} callback - final callback to invoke after termination
|
||||||
|
*/
|
||||||
|
function terminator(callback)
|
||||||
|
{
|
||||||
|
if (!Object.keys(this.jobs).length)
|
||||||
|
{
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// fast forward iteration index
|
||||||
|
this.index = this.size;
|
||||||
|
|
||||||
|
// abort jobs
|
||||||
|
abort(this);
|
||||||
|
|
||||||
|
// send back results we have so far
|
||||||
|
async(callback)(null, this.results);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,63 @@
|
||||||
|
{
|
||||||
|
"name": "asynckit",
|
||||||
|
"version": "0.4.0",
|
||||||
|
"description": "Minimal async jobs utility library, with streams support",
|
||||||
|
"main": "index.js",
|
||||||
|
"scripts": {
|
||||||
|
"clean": "rimraf coverage",
|
||||||
|
"lint": "eslint *.js lib/*.js test/*.js",
|
||||||
|
"test": "istanbul cover --reporter=json tape -- 'test/test-*.js' | tap-spec",
|
||||||
|
"win-test": "tape test/test-*.js",
|
||||||
|
"browser": "browserify -t browserify-istanbul test/lib/browserify_adjustment.js test/test-*.js | obake --coverage | tap-spec",
|
||||||
|
"report": "istanbul report",
|
||||||
|
"size": "browserify index.js | size-table asynckit",
|
||||||
|
"debug": "tape test/test-*.js"
|
||||||
|
},
|
||||||
|
"pre-commit": [
|
||||||
|
"clean",
|
||||||
|
"lint",
|
||||||
|
"test",
|
||||||
|
"browser",
|
||||||
|
"report",
|
||||||
|
"size"
|
||||||
|
],
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/alexindigo/asynckit.git"
|
||||||
|
},
|
||||||
|
"keywords": [
|
||||||
|
"async",
|
||||||
|
"jobs",
|
||||||
|
"parallel",
|
||||||
|
"serial",
|
||||||
|
"iterator",
|
||||||
|
"array",
|
||||||
|
"object",
|
||||||
|
"stream",
|
||||||
|
"destroy",
|
||||||
|
"terminate",
|
||||||
|
"abort"
|
||||||
|
],
|
||||||
|
"author": "Alex Indigo <iam@alexindigo.com>",
|
||||||
|
"license": "MIT",
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/alexindigo/asynckit/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/alexindigo/asynckit#readme",
|
||||||
|
"devDependencies": {
|
||||||
|
"browserify": "^13.0.0",
|
||||||
|
"browserify-istanbul": "^2.0.0",
|
||||||
|
"coveralls": "^2.11.9",
|
||||||
|
"eslint": "^2.9.0",
|
||||||
|
"istanbul": "^0.4.3",
|
||||||
|
"obake": "^0.1.2",
|
||||||
|
"phantomjs-prebuilt": "^2.1.7",
|
||||||
|
"pre-commit": "^1.1.3",
|
||||||
|
"reamde": "^1.1.0",
|
||||||
|
"rimraf": "^2.5.2",
|
||||||
|
"size-table": "^0.2.0",
|
||||||
|
"tap-spec": "^4.1.1",
|
||||||
|
"tape": "^4.5.1"
|
||||||
|
},
|
||||||
|
"dependencies": {}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,43 @@
|
||||||
|
var iterate = require('./lib/iterate.js')
|
||||||
|
, initState = require('./lib/state.js')
|
||||||
|
, terminator = require('./lib/terminator.js')
|
||||||
|
;
|
||||||
|
|
||||||
|
// Public API
|
||||||
|
module.exports = parallel;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs iterator over provided array elements in parallel
|
||||||
|
*
|
||||||
|
* @param {array|object} list - array or object (named list) to iterate over
|
||||||
|
* @param {function} iterator - iterator to run
|
||||||
|
* @param {function} callback - invoked when all elements processed
|
||||||
|
* @returns {function} - jobs terminator
|
||||||
|
*/
|
||||||
|
function parallel(list, iterator, callback)
|
||||||
|
{
|
||||||
|
var state = initState(list);
|
||||||
|
|
||||||
|
while (state.index < (state['keyedList'] || list).length)
|
||||||
|
{
|
||||||
|
iterate(list, iterator, state, function(error, result)
|
||||||
|
{
|
||||||
|
if (error)
|
||||||
|
{
|
||||||
|
callback(error, result);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// looks like it's the last one
|
||||||
|
if (Object.keys(state.jobs).length === 0)
|
||||||
|
{
|
||||||
|
callback(null, state.results);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
state.index++;
|
||||||
|
}
|
||||||
|
|
||||||
|
return terminator.bind(state, callback);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,17 @@
|
||||||
|
var serialOrdered = require('./serialOrdered.js');
|
||||||
|
|
||||||
|
// Public API
|
||||||
|
module.exports = serial;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs iterator over provided array elements in series
|
||||||
|
*
|
||||||
|
* @param {array|object} list - array or object (named list) to iterate over
|
||||||
|
* @param {function} iterator - iterator to run
|
||||||
|
* @param {function} callback - invoked when all elements processed
|
||||||
|
* @returns {function} - jobs terminator
|
||||||
|
*/
|
||||||
|
function serial(list, iterator, callback)
|
||||||
|
{
|
||||||
|
return serialOrdered(list, iterator, null, callback);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,75 @@
|
||||||
|
var iterate = require('./lib/iterate.js')
|
||||||
|
, initState = require('./lib/state.js')
|
||||||
|
, terminator = require('./lib/terminator.js')
|
||||||
|
;
|
||||||
|
|
||||||
|
// Public API
|
||||||
|
module.exports = serialOrdered;
|
||||||
|
// sorting helpers
|
||||||
|
module.exports.ascending = ascending;
|
||||||
|
module.exports.descending = descending;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Runs iterator over provided sorted array elements in series
|
||||||
|
*
|
||||||
|
* @param {array|object} list - array or object (named list) to iterate over
|
||||||
|
* @param {function} iterator - iterator to run
|
||||||
|
* @param {function} sortMethod - custom sort function
|
||||||
|
* @param {function} callback - invoked when all elements processed
|
||||||
|
* @returns {function} - jobs terminator
|
||||||
|
*/
|
||||||
|
function serialOrdered(list, iterator, sortMethod, callback)
|
||||||
|
{
|
||||||
|
var state = initState(list, sortMethod);
|
||||||
|
|
||||||
|
iterate(list, iterator, state, function iteratorHandler(error, result)
|
||||||
|
{
|
||||||
|
if (error)
|
||||||
|
{
|
||||||
|
callback(error, result);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
state.index++;
|
||||||
|
|
||||||
|
// are we there yet?
|
||||||
|
if (state.index < (state['keyedList'] || list).length)
|
||||||
|
{
|
||||||
|
iterate(list, iterator, state, iteratorHandler);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// done here
|
||||||
|
callback(null, state.results);
|
||||||
|
});
|
||||||
|
|
||||||
|
return terminator.bind(state, callback);
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* -- Sort methods
|
||||||
|
*/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sort helper to sort array elements in ascending order
|
||||||
|
*
|
||||||
|
* @param {mixed} a - an item to compare
|
||||||
|
* @param {mixed} b - an item to compare
|
||||||
|
* @returns {number} - comparison result
|
||||||
|
*/
|
||||||
|
function ascending(a, b)
|
||||||
|
{
|
||||||
|
return a < b ? -1 : a > b ? 1 : 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* sort helper to sort array elements in descending order
|
||||||
|
*
|
||||||
|
* @param {mixed} a - an item to compare
|
||||||
|
* @param {mixed} b - an item to compare
|
||||||
|
* @returns {number} - comparison result
|
||||||
|
*/
|
||||||
|
function descending(a, b)
|
||||||
|
{
|
||||||
|
return -1 * ascending(a, b);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,21 @@
|
||||||
|
var inherits = require('util').inherits
|
||||||
|
, Readable = require('stream').Readable
|
||||||
|
, ReadableAsyncKit = require('./lib/readable_asynckit.js')
|
||||||
|
, ReadableParallel = require('./lib/readable_parallel.js')
|
||||||
|
, ReadableSerial = require('./lib/readable_serial.js')
|
||||||
|
, ReadableSerialOrdered = require('./lib/readable_serial_ordered.js')
|
||||||
|
;
|
||||||
|
|
||||||
|
// API
|
||||||
|
module.exports =
|
||||||
|
{
|
||||||
|
parallel : ReadableParallel,
|
||||||
|
serial : ReadableSerial,
|
||||||
|
serialOrdered : ReadableSerialOrdered,
|
||||||
|
};
|
||||||
|
|
||||||
|
inherits(ReadableAsyncKit, Readable);
|
||||||
|
|
||||||
|
inherits(ReadableParallel, ReadableAsyncKit);
|
||||||
|
inherits(ReadableSerial, ReadableAsyncKit);
|
||||||
|
inherits(ReadableSerialOrdered, ReadableAsyncKit);
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -0,0 +1,7 @@
|
||||||
|
# Copyright (c) 2014-present Matt Zabriskie & Collaborators
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Migration Guide
|
||||||
|
|
||||||
|
## 0.x.x -> 1.1.0
|
||||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load Diff
File diff suppressed because one or more lines are too long
|
|
@ -0,0 +1,572 @@
|
||||||
|
interface RawAxiosHeaders {
|
||||||
|
[key: string]: axios.AxiosHeaderValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
type MethodsHeaders = Partial<{
|
||||||
|
[Key in axios.Method as Lowercase<Key>]: AxiosHeaders;
|
||||||
|
} & {common: AxiosHeaders}>;
|
||||||
|
|
||||||
|
type AxiosHeaderMatcher = string | RegExp | ((this: AxiosHeaders, value: string, name: string) => boolean);
|
||||||
|
|
||||||
|
type AxiosHeaderParser = (this: AxiosHeaders, value: axios.AxiosHeaderValue, header: string) => any;
|
||||||
|
|
||||||
|
type CommonRequestHeadersList = 'Accept' | 'Content-Length' | 'User-Agent'| 'Content-Encoding' | 'Authorization';
|
||||||
|
|
||||||
|
type ContentType = axios.AxiosHeaderValue | 'text/html' | 'text/plain' | 'multipart/form-data' | 'application/json' | 'application/x-www-form-urlencoded' | 'application/octet-stream';
|
||||||
|
|
||||||
|
type CommonResponseHeadersList = 'Server' | 'Content-Type' | 'Content-Length' | 'Cache-Control'| 'Content-Encoding';
|
||||||
|
|
||||||
|
type BrowserProgressEvent = any;
|
||||||
|
|
||||||
|
declare class AxiosHeaders {
|
||||||
|
constructor(
|
||||||
|
headers?: RawAxiosHeaders | AxiosHeaders | string
|
||||||
|
);
|
||||||
|
|
||||||
|
[key: string]: any;
|
||||||
|
|
||||||
|
set(headerName?: string, value?: axios.AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
set(headers?: RawAxiosHeaders | AxiosHeaders | string, rewrite?: boolean): AxiosHeaders;
|
||||||
|
|
||||||
|
get(headerName: string, parser: RegExp): RegExpExecArray | null;
|
||||||
|
get(headerName: string, matcher?: true | AxiosHeaderParser): axios.AxiosHeaderValue;
|
||||||
|
|
||||||
|
has(header: string, matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
delete(header: string | string[], matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
clear(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
normalize(format: boolean): AxiosHeaders;
|
||||||
|
|
||||||
|
concat(...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>): AxiosHeaders;
|
||||||
|
|
||||||
|
toJSON(asStrings?: boolean): RawAxiosHeaders;
|
||||||
|
|
||||||
|
static from(thing?: AxiosHeaders | RawAxiosHeaders | string): AxiosHeaders;
|
||||||
|
|
||||||
|
static accessor(header: string | string[]): AxiosHeaders;
|
||||||
|
|
||||||
|
static concat(...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>): AxiosHeaders;
|
||||||
|
|
||||||
|
setContentType(value: ContentType, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getContentType(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getContentType(matcher?: AxiosHeaderMatcher): axios.AxiosHeaderValue;
|
||||||
|
hasContentType(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setContentLength(value: axios.AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getContentLength(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getContentLength(matcher?: AxiosHeaderMatcher): axios.AxiosHeaderValue;
|
||||||
|
hasContentLength(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setAccept(value: axios.AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getAccept(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getAccept(matcher?: AxiosHeaderMatcher): axios.AxiosHeaderValue;
|
||||||
|
hasAccept(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setUserAgent(value: axios.AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getUserAgent(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getUserAgent(matcher?: AxiosHeaderMatcher): axios.AxiosHeaderValue;
|
||||||
|
hasUserAgent(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setContentEncoding(value: axios.AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getContentEncoding(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getContentEncoding(matcher?: AxiosHeaderMatcher): axios.AxiosHeaderValue;
|
||||||
|
hasContentEncoding(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setAuthorization(value: axios.AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getAuthorization(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getAuthorization(matcher?: AxiosHeaderMatcher): axios.AxiosHeaderValue;
|
||||||
|
hasAuthorization(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
getSetCookie(): string[];
|
||||||
|
|
||||||
|
[Symbol.iterator](): IterableIterator<[string, axios.AxiosHeaderValue]>;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare class AxiosError<T = unknown, D = any> extends Error {
|
||||||
|
constructor(
|
||||||
|
message?: string,
|
||||||
|
code?: string,
|
||||||
|
config?: axios.InternalAxiosRequestConfig<D>,
|
||||||
|
request?: any,
|
||||||
|
response?: axios.AxiosResponse<T, D>
|
||||||
|
);
|
||||||
|
|
||||||
|
config?: axios.InternalAxiosRequestConfig<D>;
|
||||||
|
code?: string;
|
||||||
|
request?: any;
|
||||||
|
response?: axios.AxiosResponse<T, D>;
|
||||||
|
isAxiosError: boolean;
|
||||||
|
status?: number;
|
||||||
|
toJSON: () => object;
|
||||||
|
cause?: unknown;
|
||||||
|
event?: BrowserProgressEvent;
|
||||||
|
static from<T = unknown, D = any>(
|
||||||
|
error: Error | unknown,
|
||||||
|
code?: string,
|
||||||
|
config?: axios.InternalAxiosRequestConfig<D>,
|
||||||
|
request?: any,
|
||||||
|
response?: axios.AxiosResponse<T, D>,
|
||||||
|
customProps?: object,
|
||||||
|
): AxiosError<T, D>;
|
||||||
|
static readonly ERR_FR_TOO_MANY_REDIRECTS = "ERR_FR_TOO_MANY_REDIRECTS";
|
||||||
|
static readonly ERR_BAD_OPTION_VALUE = "ERR_BAD_OPTION_VALUE";
|
||||||
|
static readonly ERR_BAD_OPTION = "ERR_BAD_OPTION";
|
||||||
|
static readonly ERR_NETWORK = "ERR_NETWORK";
|
||||||
|
static readonly ERR_DEPRECATED = "ERR_DEPRECATED";
|
||||||
|
static readonly ERR_BAD_RESPONSE = "ERR_BAD_RESPONSE";
|
||||||
|
static readonly ERR_BAD_REQUEST = "ERR_BAD_REQUEST";
|
||||||
|
static readonly ERR_NOT_SUPPORT = "ERR_NOT_SUPPORT";
|
||||||
|
static readonly ERR_INVALID_URL = "ERR_INVALID_URL";
|
||||||
|
static readonly ERR_CANCELED = "ERR_CANCELED";
|
||||||
|
static readonly ECONNABORTED = "ECONNABORTED";
|
||||||
|
static readonly ETIMEDOUT = "ETIMEDOUT";
|
||||||
|
}
|
||||||
|
|
||||||
|
declare class CanceledError<T> extends AxiosError<T> {
|
||||||
|
}
|
||||||
|
|
||||||
|
declare class Axios {
|
||||||
|
constructor(config?: axios.AxiosRequestConfig);
|
||||||
|
defaults: axios.AxiosDefaults;
|
||||||
|
interceptors: {
|
||||||
|
request: axios.AxiosInterceptorManager<axios.InternalAxiosRequestConfig>;
|
||||||
|
response: axios.AxiosInterceptorManager<axios.AxiosResponse>;
|
||||||
|
};
|
||||||
|
getUri(config?: axios.AxiosRequestConfig): string;
|
||||||
|
request<T = any, R = axios.AxiosResponse<T>, D = any>(config: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
get<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
delete<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
head<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
options<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
post<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
put<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
patch<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
postForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
putForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
patchForm<T = any, R = axios.AxiosResponse<T>, D = any>(url: string, data?: D, config?: axios.AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare enum HttpStatusCode {
|
||||||
|
Continue = 100,
|
||||||
|
SwitchingProtocols = 101,
|
||||||
|
Processing = 102,
|
||||||
|
EarlyHints = 103,
|
||||||
|
Ok = 200,
|
||||||
|
Created = 201,
|
||||||
|
Accepted = 202,
|
||||||
|
NonAuthoritativeInformation = 203,
|
||||||
|
NoContent = 204,
|
||||||
|
ResetContent = 205,
|
||||||
|
PartialContent = 206,
|
||||||
|
MultiStatus = 207,
|
||||||
|
AlreadyReported = 208,
|
||||||
|
ImUsed = 226,
|
||||||
|
MultipleChoices = 300,
|
||||||
|
MovedPermanently = 301,
|
||||||
|
Found = 302,
|
||||||
|
SeeOther = 303,
|
||||||
|
NotModified = 304,
|
||||||
|
UseProxy = 305,
|
||||||
|
Unused = 306,
|
||||||
|
TemporaryRedirect = 307,
|
||||||
|
PermanentRedirect = 308,
|
||||||
|
BadRequest = 400,
|
||||||
|
Unauthorized = 401,
|
||||||
|
PaymentRequired = 402,
|
||||||
|
Forbidden = 403,
|
||||||
|
NotFound = 404,
|
||||||
|
MethodNotAllowed = 405,
|
||||||
|
NotAcceptable = 406,
|
||||||
|
ProxyAuthenticationRequired = 407,
|
||||||
|
RequestTimeout = 408,
|
||||||
|
Conflict = 409,
|
||||||
|
Gone = 410,
|
||||||
|
LengthRequired = 411,
|
||||||
|
PreconditionFailed = 412,
|
||||||
|
PayloadTooLarge = 413,
|
||||||
|
UriTooLong = 414,
|
||||||
|
UnsupportedMediaType = 415,
|
||||||
|
RangeNotSatisfiable = 416,
|
||||||
|
ExpectationFailed = 417,
|
||||||
|
ImATeapot = 418,
|
||||||
|
MisdirectedRequest = 421,
|
||||||
|
UnprocessableEntity = 422,
|
||||||
|
Locked = 423,
|
||||||
|
FailedDependency = 424,
|
||||||
|
TooEarly = 425,
|
||||||
|
UpgradeRequired = 426,
|
||||||
|
PreconditionRequired = 428,
|
||||||
|
TooManyRequests = 429,
|
||||||
|
RequestHeaderFieldsTooLarge = 431,
|
||||||
|
UnavailableForLegalReasons = 451,
|
||||||
|
InternalServerError = 500,
|
||||||
|
NotImplemented = 501,
|
||||||
|
BadGateway = 502,
|
||||||
|
ServiceUnavailable = 503,
|
||||||
|
GatewayTimeout = 504,
|
||||||
|
HttpVersionNotSupported = 505,
|
||||||
|
VariantAlsoNegotiates = 506,
|
||||||
|
InsufficientStorage = 507,
|
||||||
|
LoopDetected = 508,
|
||||||
|
NotExtended = 510,
|
||||||
|
NetworkAuthenticationRequired = 511,
|
||||||
|
}
|
||||||
|
|
||||||
|
type InternalAxiosError<T = unknown, D = any> = AxiosError<T, D>;
|
||||||
|
|
||||||
|
declare namespace axios {
|
||||||
|
type AxiosError<T = unknown, D = any> = InternalAxiosError<T, D>;
|
||||||
|
|
||||||
|
type RawAxiosRequestHeaders = Partial<RawAxiosHeaders & {
|
||||||
|
[Key in CommonRequestHeadersList]: AxiosHeaderValue;
|
||||||
|
} & {
|
||||||
|
'Content-Type': ContentType
|
||||||
|
}>;
|
||||||
|
|
||||||
|
type AxiosRequestHeaders = RawAxiosRequestHeaders & AxiosHeaders;
|
||||||
|
|
||||||
|
type AxiosHeaderValue = AxiosHeaders | string | string[] | number | boolean | null;
|
||||||
|
|
||||||
|
type RawCommonResponseHeaders = {
|
||||||
|
[Key in CommonResponseHeadersList]: AxiosHeaderValue;
|
||||||
|
} & {
|
||||||
|
"set-cookie": string[];
|
||||||
|
};
|
||||||
|
|
||||||
|
type RawAxiosResponseHeaders = Partial<RawAxiosHeaders & RawCommonResponseHeaders>;
|
||||||
|
|
||||||
|
type AxiosResponseHeaders = RawAxiosResponseHeaders & AxiosHeaders;
|
||||||
|
|
||||||
|
interface AxiosRequestTransformer {
|
||||||
|
(this: InternalAxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosResponseTransformer {
|
||||||
|
(this: InternalAxiosRequestConfig, data: any, headers: AxiosResponseHeaders, status?: number): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosAdapter {
|
||||||
|
(config: InternalAxiosRequestConfig): AxiosPromise;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosBasicCredentials {
|
||||||
|
username: string;
|
||||||
|
password: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosProxyConfig {
|
||||||
|
host: string;
|
||||||
|
port: number;
|
||||||
|
auth?: AxiosBasicCredentials;
|
||||||
|
protocol?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
type Method =
|
||||||
|
| 'get' | 'GET'
|
||||||
|
| 'delete' | 'DELETE'
|
||||||
|
| 'head' | 'HEAD'
|
||||||
|
| 'options' | 'OPTIONS'
|
||||||
|
| 'post' | 'POST'
|
||||||
|
| 'put' | 'PUT'
|
||||||
|
| 'patch' | 'PATCH'
|
||||||
|
| 'purge' | 'PURGE'
|
||||||
|
| 'link' | 'LINK'
|
||||||
|
| 'unlink' | 'UNLINK';
|
||||||
|
|
||||||
|
type ResponseType =
|
||||||
|
| 'arraybuffer'
|
||||||
|
| 'blob'
|
||||||
|
| 'document'
|
||||||
|
| 'json'
|
||||||
|
| 'text'
|
||||||
|
| 'stream'
|
||||||
|
| 'formdata';
|
||||||
|
|
||||||
|
type responseEncoding =
|
||||||
|
| 'ascii' | 'ASCII'
|
||||||
|
| 'ansi' | 'ANSI'
|
||||||
|
| 'binary' | 'BINARY'
|
||||||
|
| 'base64' | 'BASE64'
|
||||||
|
| 'base64url' | 'BASE64URL'
|
||||||
|
| 'hex' | 'HEX'
|
||||||
|
| 'latin1' | 'LATIN1'
|
||||||
|
| 'ucs-2' | 'UCS-2'
|
||||||
|
| 'ucs2' | 'UCS2'
|
||||||
|
| 'utf-8' | 'UTF-8'
|
||||||
|
| 'utf8' | 'UTF8'
|
||||||
|
| 'utf16le' | 'UTF16LE';
|
||||||
|
|
||||||
|
interface TransitionalOptions {
|
||||||
|
silentJSONParsing?: boolean;
|
||||||
|
forcedJSONParsing?: boolean;
|
||||||
|
clarifyTimeoutError?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GenericAbortSignal {
|
||||||
|
readonly aborted: boolean;
|
||||||
|
onabort?: ((...args: any) => any) | null;
|
||||||
|
addEventListener?: (...args: any) => any;
|
||||||
|
removeEventListener?: (...args: any) => any;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface FormDataVisitorHelpers {
|
||||||
|
defaultVisitor: SerializerVisitor;
|
||||||
|
convertValue: (value: any) => any;
|
||||||
|
isVisitable: (value: any) => boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SerializerVisitor {
|
||||||
|
(
|
||||||
|
this: GenericFormData,
|
||||||
|
value: any,
|
||||||
|
key: string | number,
|
||||||
|
path: null | Array<string | number>,
|
||||||
|
helpers: FormDataVisitorHelpers
|
||||||
|
): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface SerializerOptions {
|
||||||
|
visitor?: SerializerVisitor;
|
||||||
|
dots?: boolean;
|
||||||
|
metaTokens?: boolean;
|
||||||
|
indexes?: boolean | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// tslint:disable-next-line
|
||||||
|
interface FormSerializerOptions extends SerializerOptions {
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ParamEncoder {
|
||||||
|
(value: any, defaultEncoder: (value: any) => any): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CustomParamsSerializer {
|
||||||
|
(params: Record<string, any>, options?: ParamsSerializerOptions): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface ParamsSerializerOptions extends SerializerOptions {
|
||||||
|
encode?: ParamEncoder;
|
||||||
|
serialize?: CustomParamsSerializer;
|
||||||
|
}
|
||||||
|
|
||||||
|
type MaxUploadRate = number;
|
||||||
|
|
||||||
|
type MaxDownloadRate = number;
|
||||||
|
|
||||||
|
interface AxiosProgressEvent {
|
||||||
|
loaded: number;
|
||||||
|
total?: number;
|
||||||
|
progress?: number;
|
||||||
|
bytes: number;
|
||||||
|
rate?: number;
|
||||||
|
estimated?: number;
|
||||||
|
upload?: boolean;
|
||||||
|
download?: boolean;
|
||||||
|
event?: BrowserProgressEvent;
|
||||||
|
lengthComputable: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
type Milliseconds = number;
|
||||||
|
|
||||||
|
type AxiosAdapterName = 'fetch' | 'xhr' | 'http' | (string & {});
|
||||||
|
|
||||||
|
type AxiosAdapterConfig = AxiosAdapter | AxiosAdapterName;
|
||||||
|
|
||||||
|
type AddressFamily = 4 | 6 | undefined;
|
||||||
|
|
||||||
|
interface LookupAddressEntry {
|
||||||
|
address: string;
|
||||||
|
family?: AddressFamily;
|
||||||
|
}
|
||||||
|
|
||||||
|
type LookupAddress = string | LookupAddressEntry;
|
||||||
|
|
||||||
|
interface AxiosRequestConfig<D = any> {
|
||||||
|
url?: string;
|
||||||
|
method?: Method | string;
|
||||||
|
baseURL?: string;
|
||||||
|
allowAbsoluteUrls?: boolean;
|
||||||
|
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
|
||||||
|
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
|
||||||
|
headers?: (RawAxiosRequestHeaders & MethodsHeaders) | AxiosHeaders;
|
||||||
|
params?: any;
|
||||||
|
paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
|
||||||
|
data?: D;
|
||||||
|
timeout?: Milliseconds;
|
||||||
|
timeoutErrorMessage?: string;
|
||||||
|
withCredentials?: boolean;
|
||||||
|
adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
|
||||||
|
auth?: AxiosBasicCredentials;
|
||||||
|
responseType?: ResponseType;
|
||||||
|
responseEncoding?: responseEncoding | string;
|
||||||
|
xsrfCookieName?: string;
|
||||||
|
xsrfHeaderName?: string;
|
||||||
|
onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
|
||||||
|
onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
|
||||||
|
maxContentLength?: number;
|
||||||
|
validateStatus?: ((status: number) => boolean) | null;
|
||||||
|
maxBodyLength?: number;
|
||||||
|
maxRedirects?: number;
|
||||||
|
maxRate?: number | [MaxUploadRate, MaxDownloadRate];
|
||||||
|
beforeRedirect?: (options: Record<string, any>, responseDetails: {headers: Record<string, string>, statusCode: HttpStatusCode}) => void;
|
||||||
|
socketPath?: string | null;
|
||||||
|
transport?: any;
|
||||||
|
httpAgent?: any;
|
||||||
|
httpsAgent?: any;
|
||||||
|
proxy?: AxiosProxyConfig | false;
|
||||||
|
cancelToken?: CancelToken;
|
||||||
|
decompress?: boolean;
|
||||||
|
transitional?: TransitionalOptions;
|
||||||
|
signal?: GenericAbortSignal;
|
||||||
|
insecureHTTPParser?: boolean;
|
||||||
|
env?: {
|
||||||
|
FormData?: new (...args: any[]) => object;
|
||||||
|
fetch?: (input: URL | Request | string, init?: RequestInit) => Promise<Response>;
|
||||||
|
Request?: new (input: URL | Request | string, init?: RequestInit) => Request;
|
||||||
|
Response?: new (
|
||||||
|
body?: ArrayBuffer | ArrayBufferView | Blob | FormData | URLSearchParams | string | null,
|
||||||
|
init?: ResponseInit
|
||||||
|
) => Response;
|
||||||
|
};
|
||||||
|
formSerializer?: FormSerializerOptions;
|
||||||
|
family?: AddressFamily;
|
||||||
|
lookup?: ((hostname: string, options: object, cb: (err: Error | null, address: LookupAddress | LookupAddress[], family?: AddressFamily) => void) => void) |
|
||||||
|
((hostname: string, options: object) => Promise<[address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily] | LookupAddress>);
|
||||||
|
withXSRFToken?: boolean | ((config: InternalAxiosRequestConfig) => boolean | undefined);
|
||||||
|
fetchOptions?: Omit<RequestInit, 'body' | 'headers' | 'method' | 'signal'> | Record<string, any>;
|
||||||
|
httpVersion?: 1 | 2;
|
||||||
|
http2Options?: Record<string, any> & {
|
||||||
|
sessionTimeout?: number;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Alias
|
||||||
|
type RawAxiosRequestConfig<D = any> = AxiosRequestConfig<D>;
|
||||||
|
|
||||||
|
interface InternalAxiosRequestConfig<D = any> extends AxiosRequestConfig<D> {
|
||||||
|
headers: AxiosRequestHeaders;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface HeadersDefaults {
|
||||||
|
common: RawAxiosRequestHeaders;
|
||||||
|
delete: RawAxiosRequestHeaders;
|
||||||
|
get: RawAxiosRequestHeaders;
|
||||||
|
head: RawAxiosRequestHeaders;
|
||||||
|
post: RawAxiosRequestHeaders;
|
||||||
|
put: RawAxiosRequestHeaders;
|
||||||
|
patch: RawAxiosRequestHeaders;
|
||||||
|
options?: RawAxiosRequestHeaders;
|
||||||
|
purge?: RawAxiosRequestHeaders;
|
||||||
|
link?: RawAxiosRequestHeaders;
|
||||||
|
unlink?: RawAxiosRequestHeaders;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
|
||||||
|
headers: HeadersDefaults;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CreateAxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
|
||||||
|
headers?: RawAxiosRequestHeaders | AxiosHeaders | Partial<HeadersDefaults>;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosResponse<T = any, D = any, H = {}> {
|
||||||
|
data: T;
|
||||||
|
status: number;
|
||||||
|
statusText: string;
|
||||||
|
headers: H & RawAxiosResponseHeaders | AxiosResponseHeaders;
|
||||||
|
config: InternalAxiosRequestConfig<D>;
|
||||||
|
request?: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
type AxiosPromise<T = any> = Promise<AxiosResponse<T>>;
|
||||||
|
|
||||||
|
interface CancelStatic {
|
||||||
|
new (message?: string): Cancel;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Cancel {
|
||||||
|
message: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Canceler {
|
||||||
|
(message?: string, config?: AxiosRequestConfig, request?: any): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CancelTokenStatic {
|
||||||
|
new (executor: (cancel: Canceler) => void): CancelToken;
|
||||||
|
source(): CancelTokenSource;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CancelToken {
|
||||||
|
promise: Promise<Cancel>;
|
||||||
|
reason?: Cancel;
|
||||||
|
throwIfRequested(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface CancelTokenSource {
|
||||||
|
token: CancelToken;
|
||||||
|
cancel: Canceler;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosInterceptorOptions {
|
||||||
|
synchronous?: boolean;
|
||||||
|
runWhen?: (config: InternalAxiosRequestConfig) => boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
type AxiosRequestInterceptorUse<T> = (onFulfilled?: ((value: T) => T | Promise<T>) | null, onRejected?: ((error: any) => any) | null, options?: AxiosInterceptorOptions) => number;
|
||||||
|
|
||||||
|
type AxiosResponseInterceptorUse<T> = (onFulfilled?: ((value: T) => T | Promise<T>) | null, onRejected?: ((error: any) => any) | null) => number;
|
||||||
|
|
||||||
|
interface AxiosInterceptorManager<V> {
|
||||||
|
use: V extends AxiosResponse ? AxiosResponseInterceptorUse<V> : AxiosRequestInterceptorUse<V>;
|
||||||
|
eject(id: number): void;
|
||||||
|
clear(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosInstance extends Axios {
|
||||||
|
<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
|
||||||
|
create(config?: CreateAxiosDefaults): AxiosInstance;
|
||||||
|
defaults: Omit<AxiosDefaults, 'headers'> & {
|
||||||
|
headers: HeadersDefaults & {
|
||||||
|
[key: string]: AxiosHeaderValue
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GenericFormData {
|
||||||
|
append(name: string, value: any, options?: any): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface GenericHTMLFormElement {
|
||||||
|
name: string;
|
||||||
|
method: string;
|
||||||
|
submit(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
interface AxiosStatic extends AxiosInstance {
|
||||||
|
Cancel: CancelStatic;
|
||||||
|
CancelToken: CancelTokenStatic;
|
||||||
|
Axios: typeof Axios;
|
||||||
|
AxiosError: typeof AxiosError;
|
||||||
|
CanceledError: typeof CanceledError;
|
||||||
|
HttpStatusCode: typeof HttpStatusCode;
|
||||||
|
readonly VERSION: string;
|
||||||
|
isCancel(value: any): value is Cancel;
|
||||||
|
all<T>(values: Array<T | Promise<T>>): Promise<T[]>;
|
||||||
|
spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;
|
||||||
|
isAxiosError<T = any, D = any>(payload: any): payload is AxiosError<T, D>;
|
||||||
|
toFormData(sourceObj: object, targetFormData?: GenericFormData, options?: FormSerializerOptions): GenericFormData;
|
||||||
|
formToJSON(form: GenericFormData|GenericHTMLFormElement): object;
|
||||||
|
getAdapter(adapters: AxiosAdapterConfig | AxiosAdapterConfig[] | undefined): AxiosAdapter;
|
||||||
|
AxiosHeaders: typeof AxiosHeaders;
|
||||||
|
mergeConfig<D = any>(config1: AxiosRequestConfig<D>, config2: AxiosRequestConfig<D>): AxiosRequestConfig<D>;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
declare const axios: axios.AxiosStatic;
|
||||||
|
|
||||||
|
export = axios;
|
||||||
|
|
@ -0,0 +1,585 @@
|
||||||
|
// TypeScript Version: 4.7
|
||||||
|
export type AxiosHeaderValue = AxiosHeaders | string | string[] | number | boolean | null;
|
||||||
|
|
||||||
|
interface RawAxiosHeaders {
|
||||||
|
[key: string]: AxiosHeaderValue;
|
||||||
|
}
|
||||||
|
|
||||||
|
type MethodsHeaders = Partial<{
|
||||||
|
[Key in Method as Lowercase<Key>]: AxiosHeaders;
|
||||||
|
} & {common: AxiosHeaders}>;
|
||||||
|
|
||||||
|
type AxiosHeaderMatcher = string | RegExp | ((this: AxiosHeaders, value: string, name: string) => boolean);
|
||||||
|
|
||||||
|
type AxiosHeaderParser = (this: AxiosHeaders, value: AxiosHeaderValue, header: string) => any;
|
||||||
|
|
||||||
|
export class AxiosHeaders {
|
||||||
|
constructor(
|
||||||
|
headers?: RawAxiosHeaders | AxiosHeaders | string
|
||||||
|
);
|
||||||
|
|
||||||
|
[key: string]: any;
|
||||||
|
|
||||||
|
set(headerName?: string, value?: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
set(headers?: RawAxiosHeaders | AxiosHeaders | string, rewrite?: boolean): AxiosHeaders;
|
||||||
|
|
||||||
|
get(headerName: string, parser: RegExp): RegExpExecArray | null;
|
||||||
|
get(headerName: string, matcher?: true | AxiosHeaderParser): AxiosHeaderValue;
|
||||||
|
|
||||||
|
has(header: string, matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
delete(header: string | string[], matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
clear(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
normalize(format: boolean): AxiosHeaders;
|
||||||
|
|
||||||
|
concat(...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>): AxiosHeaders;
|
||||||
|
|
||||||
|
toJSON(asStrings?: boolean): RawAxiosHeaders;
|
||||||
|
|
||||||
|
static from(thing?: AxiosHeaders | RawAxiosHeaders | string): AxiosHeaders;
|
||||||
|
|
||||||
|
static accessor(header: string | string[]): AxiosHeaders;
|
||||||
|
|
||||||
|
static concat(...targets: Array<AxiosHeaders | RawAxiosHeaders | string | undefined | null>): AxiosHeaders;
|
||||||
|
|
||||||
|
setContentType(value: ContentType, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getContentType(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getContentType(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
|
||||||
|
hasContentType(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setContentLength(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getContentLength(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getContentLength(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
|
||||||
|
hasContentLength(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setAccept(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getAccept(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getAccept(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
|
||||||
|
hasAccept(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setUserAgent(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getUserAgent(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getUserAgent(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
|
||||||
|
hasUserAgent(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setContentEncoding(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getContentEncoding(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getContentEncoding(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
|
||||||
|
hasContentEncoding(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
setAuthorization(value: AxiosHeaderValue, rewrite?: boolean | AxiosHeaderMatcher): AxiosHeaders;
|
||||||
|
getAuthorization(parser?: RegExp): RegExpExecArray | null;
|
||||||
|
getAuthorization(matcher?: AxiosHeaderMatcher): AxiosHeaderValue;
|
||||||
|
hasAuthorization(matcher?: AxiosHeaderMatcher): boolean;
|
||||||
|
|
||||||
|
getSetCookie(): string[];
|
||||||
|
|
||||||
|
[Symbol.iterator](): IterableIterator<[string, AxiosHeaderValue]>;
|
||||||
|
}
|
||||||
|
|
||||||
|
type CommonRequestHeadersList = 'Accept' | 'Content-Length' | 'User-Agent' | 'Content-Encoding' | 'Authorization';
|
||||||
|
|
||||||
|
type ContentType = AxiosHeaderValue | 'text/html' | 'text/plain' | 'multipart/form-data' | 'application/json' | 'application/x-www-form-urlencoded' | 'application/octet-stream';
|
||||||
|
|
||||||
|
export type RawAxiosRequestHeaders = Partial<RawAxiosHeaders & {
|
||||||
|
[Key in CommonRequestHeadersList]: AxiosHeaderValue;
|
||||||
|
} & {
|
||||||
|
'Content-Type': ContentType
|
||||||
|
}>;
|
||||||
|
|
||||||
|
export type AxiosRequestHeaders = RawAxiosRequestHeaders & AxiosHeaders;
|
||||||
|
|
||||||
|
type CommonResponseHeadersList = 'Server' | 'Content-Type' | 'Content-Length' | 'Cache-Control'| 'Content-Encoding';
|
||||||
|
|
||||||
|
type RawCommonResponseHeaders = {
|
||||||
|
[Key in CommonResponseHeadersList]: AxiosHeaderValue;
|
||||||
|
} & {
|
||||||
|
"set-cookie": string[];
|
||||||
|
};
|
||||||
|
|
||||||
|
export type RawAxiosResponseHeaders = Partial<RawAxiosHeaders & RawCommonResponseHeaders>;
|
||||||
|
|
||||||
|
export type AxiosResponseHeaders = RawAxiosResponseHeaders & AxiosHeaders;
|
||||||
|
|
||||||
|
export interface AxiosRequestTransformer {
|
||||||
|
(this: InternalAxiosRequestConfig, data: any, headers: AxiosRequestHeaders): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AxiosResponseTransformer {
|
||||||
|
(this: InternalAxiosRequestConfig, data: any, headers: AxiosResponseHeaders, status?: number): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AxiosAdapter {
|
||||||
|
(config: InternalAxiosRequestConfig): AxiosPromise;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AxiosBasicCredentials {
|
||||||
|
username: string;
|
||||||
|
password: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AxiosProxyConfig {
|
||||||
|
host: string;
|
||||||
|
port: number;
|
||||||
|
auth?: AxiosBasicCredentials;
|
||||||
|
protocol?: string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum HttpStatusCode {
|
||||||
|
Continue = 100,
|
||||||
|
SwitchingProtocols = 101,
|
||||||
|
Processing = 102,
|
||||||
|
EarlyHints = 103,
|
||||||
|
Ok = 200,
|
||||||
|
Created = 201,
|
||||||
|
Accepted = 202,
|
||||||
|
NonAuthoritativeInformation = 203,
|
||||||
|
NoContent = 204,
|
||||||
|
ResetContent = 205,
|
||||||
|
PartialContent = 206,
|
||||||
|
MultiStatus = 207,
|
||||||
|
AlreadyReported = 208,
|
||||||
|
ImUsed = 226,
|
||||||
|
MultipleChoices = 300,
|
||||||
|
MovedPermanently = 301,
|
||||||
|
Found = 302,
|
||||||
|
SeeOther = 303,
|
||||||
|
NotModified = 304,
|
||||||
|
UseProxy = 305,
|
||||||
|
Unused = 306,
|
||||||
|
TemporaryRedirect = 307,
|
||||||
|
PermanentRedirect = 308,
|
||||||
|
BadRequest = 400,
|
||||||
|
Unauthorized = 401,
|
||||||
|
PaymentRequired = 402,
|
||||||
|
Forbidden = 403,
|
||||||
|
NotFound = 404,
|
||||||
|
MethodNotAllowed = 405,
|
||||||
|
NotAcceptable = 406,
|
||||||
|
ProxyAuthenticationRequired = 407,
|
||||||
|
RequestTimeout = 408,
|
||||||
|
Conflict = 409,
|
||||||
|
Gone = 410,
|
||||||
|
LengthRequired = 411,
|
||||||
|
PreconditionFailed = 412,
|
||||||
|
PayloadTooLarge = 413,
|
||||||
|
UriTooLong = 414,
|
||||||
|
UnsupportedMediaType = 415,
|
||||||
|
RangeNotSatisfiable = 416,
|
||||||
|
ExpectationFailed = 417,
|
||||||
|
ImATeapot = 418,
|
||||||
|
MisdirectedRequest = 421,
|
||||||
|
UnprocessableEntity = 422,
|
||||||
|
Locked = 423,
|
||||||
|
FailedDependency = 424,
|
||||||
|
TooEarly = 425,
|
||||||
|
UpgradeRequired = 426,
|
||||||
|
PreconditionRequired = 428,
|
||||||
|
TooManyRequests = 429,
|
||||||
|
RequestHeaderFieldsTooLarge = 431,
|
||||||
|
UnavailableForLegalReasons = 451,
|
||||||
|
InternalServerError = 500,
|
||||||
|
NotImplemented = 501,
|
||||||
|
BadGateway = 502,
|
||||||
|
ServiceUnavailable = 503,
|
||||||
|
GatewayTimeout = 504,
|
||||||
|
HttpVersionNotSupported = 505,
|
||||||
|
VariantAlsoNegotiates = 506,
|
||||||
|
InsufficientStorage = 507,
|
||||||
|
LoopDetected = 508,
|
||||||
|
NotExtended = 510,
|
||||||
|
NetworkAuthenticationRequired = 511,
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Method =
|
||||||
|
| 'get' | 'GET'
|
||||||
|
| 'delete' | 'DELETE'
|
||||||
|
| 'head' | 'HEAD'
|
||||||
|
| 'options' | 'OPTIONS'
|
||||||
|
| 'post' | 'POST'
|
||||||
|
| 'put' | 'PUT'
|
||||||
|
| 'patch' | 'PATCH'
|
||||||
|
| 'purge' | 'PURGE'
|
||||||
|
| 'link' | 'LINK'
|
||||||
|
| 'unlink' | 'UNLINK';
|
||||||
|
|
||||||
|
export type ResponseType =
|
||||||
|
| 'arraybuffer'
|
||||||
|
| 'blob'
|
||||||
|
| 'document'
|
||||||
|
| 'json'
|
||||||
|
| 'text'
|
||||||
|
| 'stream'
|
||||||
|
| 'formdata';
|
||||||
|
|
||||||
|
export type responseEncoding =
|
||||||
|
| 'ascii' | 'ASCII'
|
||||||
|
| 'ansi' | 'ANSI'
|
||||||
|
| 'binary' | 'BINARY'
|
||||||
|
| 'base64' | 'BASE64'
|
||||||
|
| 'base64url' | 'BASE64URL'
|
||||||
|
| 'hex' | 'HEX'
|
||||||
|
| 'latin1' | 'LATIN1'
|
||||||
|
| 'ucs-2' | 'UCS-2'
|
||||||
|
| 'ucs2' | 'UCS2'
|
||||||
|
| 'utf-8' | 'UTF-8'
|
||||||
|
| 'utf8' | 'UTF8'
|
||||||
|
| 'utf16le' | 'UTF16LE';
|
||||||
|
|
||||||
|
export interface TransitionalOptions {
|
||||||
|
silentJSONParsing?: boolean;
|
||||||
|
forcedJSONParsing?: boolean;
|
||||||
|
clarifyTimeoutError?: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface GenericAbortSignal {
|
||||||
|
readonly aborted: boolean;
|
||||||
|
onabort?: ((...args: any) => any) | null;
|
||||||
|
addEventListener?: (...args: any) => any;
|
||||||
|
removeEventListener?: (...args: any) => any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface FormDataVisitorHelpers {
|
||||||
|
defaultVisitor: SerializerVisitor;
|
||||||
|
convertValue: (value: any) => any;
|
||||||
|
isVisitable: (value: any) => boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SerializerVisitor {
|
||||||
|
(
|
||||||
|
this: GenericFormData,
|
||||||
|
value: any,
|
||||||
|
key: string | number,
|
||||||
|
path: null | Array<string | number>,
|
||||||
|
helpers: FormDataVisitorHelpers
|
||||||
|
): boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SerializerOptions {
|
||||||
|
visitor?: SerializerVisitor;
|
||||||
|
dots?: boolean;
|
||||||
|
metaTokens?: boolean;
|
||||||
|
indexes?: boolean | null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// tslint:disable-next-line
|
||||||
|
export interface FormSerializerOptions extends SerializerOptions {
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ParamEncoder {
|
||||||
|
(value: any, defaultEncoder: (value: any) => any): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CustomParamsSerializer {
|
||||||
|
(params: Record<string, any>, options?: ParamsSerializerOptions): string;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ParamsSerializerOptions extends SerializerOptions {
|
||||||
|
encode?: ParamEncoder;
|
||||||
|
serialize?: CustomParamsSerializer;
|
||||||
|
}
|
||||||
|
|
||||||
|
type MaxUploadRate = number;
|
||||||
|
|
||||||
|
type MaxDownloadRate = number;
|
||||||
|
|
||||||
|
type BrowserProgressEvent = any;
|
||||||
|
|
||||||
|
export interface AxiosProgressEvent {
|
||||||
|
loaded: number;
|
||||||
|
total?: number;
|
||||||
|
progress?: number;
|
||||||
|
bytes: number;
|
||||||
|
rate?: number;
|
||||||
|
estimated?: number;
|
||||||
|
upload?: boolean;
|
||||||
|
download?: boolean;
|
||||||
|
event?: BrowserProgressEvent;
|
||||||
|
lengthComputable: boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
type Milliseconds = number;
|
||||||
|
|
||||||
|
type AxiosAdapterName = 'fetch' | 'xhr' | 'http' | (string & {});
|
||||||
|
|
||||||
|
type AxiosAdapterConfig = AxiosAdapter | AxiosAdapterName;
|
||||||
|
|
||||||
|
export type AddressFamily = 4 | 6 | undefined;
|
||||||
|
|
||||||
|
export interface LookupAddressEntry {
|
||||||
|
address: string;
|
||||||
|
family?: AddressFamily;
|
||||||
|
}
|
||||||
|
|
||||||
|
export type LookupAddress = string | LookupAddressEntry;
|
||||||
|
|
||||||
|
export interface AxiosRequestConfig<D = any> {
|
||||||
|
url?: string;
|
||||||
|
method?: Method | string;
|
||||||
|
baseURL?: string;
|
||||||
|
allowAbsoluteUrls?: boolean;
|
||||||
|
transformRequest?: AxiosRequestTransformer | AxiosRequestTransformer[];
|
||||||
|
transformResponse?: AxiosResponseTransformer | AxiosResponseTransformer[];
|
||||||
|
headers?: (RawAxiosRequestHeaders & MethodsHeaders) | AxiosHeaders;
|
||||||
|
params?: any;
|
||||||
|
paramsSerializer?: ParamsSerializerOptions | CustomParamsSerializer;
|
||||||
|
data?: D;
|
||||||
|
timeout?: Milliseconds;
|
||||||
|
timeoutErrorMessage?: string;
|
||||||
|
withCredentials?: boolean;
|
||||||
|
adapter?: AxiosAdapterConfig | AxiosAdapterConfig[];
|
||||||
|
auth?: AxiosBasicCredentials;
|
||||||
|
responseType?: ResponseType;
|
||||||
|
responseEncoding?: responseEncoding | string;
|
||||||
|
xsrfCookieName?: string;
|
||||||
|
xsrfHeaderName?: string;
|
||||||
|
onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
|
||||||
|
onDownloadProgress?: (progressEvent: AxiosProgressEvent) => void;
|
||||||
|
maxContentLength?: number;
|
||||||
|
validateStatus?: ((status: number) => boolean) | null;
|
||||||
|
maxBodyLength?: number;
|
||||||
|
maxRedirects?: number;
|
||||||
|
maxRate?: number | [MaxUploadRate, MaxDownloadRate];
|
||||||
|
beforeRedirect?: (options: Record<string, any>, responseDetails: {headers: Record<string, string>, statusCode: HttpStatusCode}) => void;
|
||||||
|
socketPath?: string | null;
|
||||||
|
transport?: any;
|
||||||
|
httpAgent?: any;
|
||||||
|
httpsAgent?: any;
|
||||||
|
proxy?: AxiosProxyConfig | false;
|
||||||
|
cancelToken?: CancelToken;
|
||||||
|
decompress?: boolean;
|
||||||
|
transitional?: TransitionalOptions;
|
||||||
|
signal?: GenericAbortSignal;
|
||||||
|
insecureHTTPParser?: boolean;
|
||||||
|
env?: {
|
||||||
|
FormData?: new (...args: any[]) => object;
|
||||||
|
fetch?: (input: URL | Request | string, init?: RequestInit) => Promise<Response>;
|
||||||
|
Request?: new (input: URL | Request | string, init?: RequestInit) => Request;
|
||||||
|
Response?: new (
|
||||||
|
body?: ArrayBuffer | ArrayBufferView | Blob | FormData | URLSearchParams | string | null,
|
||||||
|
init?: ResponseInit
|
||||||
|
) => Response;
|
||||||
|
};
|
||||||
|
formSerializer?: FormSerializerOptions;
|
||||||
|
family?: AddressFamily;
|
||||||
|
lookup?: ((hostname: string, options: object, cb: (err: Error | null, address: LookupAddress | LookupAddress[], family?: AddressFamily) => void) => void) |
|
||||||
|
((hostname: string, options: object) => Promise<[address: LookupAddressEntry | LookupAddressEntry[], family?: AddressFamily] | LookupAddress>);
|
||||||
|
withXSRFToken?: boolean | ((config: InternalAxiosRequestConfig) => boolean | undefined);
|
||||||
|
parseReviver?: (this: any, key: string, value: any) => any;
|
||||||
|
fetchOptions?: Omit<RequestInit, 'body' | 'headers' | 'method' | 'signal'> | Record<string, any>;
|
||||||
|
httpVersion?: 1 | 2;
|
||||||
|
http2Options?: Record<string, any> & {
|
||||||
|
sessionTimeout?: number;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Alias
|
||||||
|
export type RawAxiosRequestConfig<D = any> = AxiosRequestConfig<D>;
|
||||||
|
|
||||||
|
export interface InternalAxiosRequestConfig<D = any> extends AxiosRequestConfig<D> {
|
||||||
|
headers: AxiosRequestHeaders;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface HeadersDefaults {
|
||||||
|
common: RawAxiosRequestHeaders;
|
||||||
|
delete: RawAxiosRequestHeaders;
|
||||||
|
get: RawAxiosRequestHeaders;
|
||||||
|
head: RawAxiosRequestHeaders;
|
||||||
|
post: RawAxiosRequestHeaders;
|
||||||
|
put: RawAxiosRequestHeaders;
|
||||||
|
patch: RawAxiosRequestHeaders;
|
||||||
|
options?: RawAxiosRequestHeaders;
|
||||||
|
purge?: RawAxiosRequestHeaders;
|
||||||
|
link?: RawAxiosRequestHeaders;
|
||||||
|
unlink?: RawAxiosRequestHeaders;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
|
||||||
|
headers: HeadersDefaults;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CreateAxiosDefaults<D = any> extends Omit<AxiosRequestConfig<D>, 'headers'> {
|
||||||
|
headers?: RawAxiosRequestHeaders | AxiosHeaders | Partial<HeadersDefaults>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AxiosResponse<T = any, D = any, H = {}> {
|
||||||
|
data: T;
|
||||||
|
status: number;
|
||||||
|
statusText: string;
|
||||||
|
headers: H & RawAxiosResponseHeaders | AxiosResponseHeaders;
|
||||||
|
config: InternalAxiosRequestConfig<D>;
|
||||||
|
request?: any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class AxiosError<T = unknown, D = any> extends Error {
|
||||||
|
constructor(
|
||||||
|
message?: string,
|
||||||
|
code?: string,
|
||||||
|
config?: InternalAxiosRequestConfig<D>,
|
||||||
|
request?: any,
|
||||||
|
response?: AxiosResponse<T, D>
|
||||||
|
);
|
||||||
|
|
||||||
|
config?: InternalAxiosRequestConfig<D>;
|
||||||
|
code?: string;
|
||||||
|
request?: any;
|
||||||
|
response?: AxiosResponse<T, D>;
|
||||||
|
isAxiosError: boolean;
|
||||||
|
status?: number;
|
||||||
|
toJSON: () => object;
|
||||||
|
cause?: unknown;
|
||||||
|
event?: BrowserProgressEvent;
|
||||||
|
static from<T = unknown, D = any>(
|
||||||
|
error: Error | unknown,
|
||||||
|
code?: string,
|
||||||
|
config?: InternalAxiosRequestConfig<D>,
|
||||||
|
request?: any,
|
||||||
|
response?: AxiosResponse<T, D>,
|
||||||
|
customProps?: object,
|
||||||
|
): AxiosError<T, D>;
|
||||||
|
static readonly ERR_FR_TOO_MANY_REDIRECTS = "ERR_FR_TOO_MANY_REDIRECTS";
|
||||||
|
static readonly ERR_BAD_OPTION_VALUE = "ERR_BAD_OPTION_VALUE";
|
||||||
|
static readonly ERR_BAD_OPTION = "ERR_BAD_OPTION";
|
||||||
|
static readonly ERR_NETWORK = "ERR_NETWORK";
|
||||||
|
static readonly ERR_DEPRECATED = "ERR_DEPRECATED";
|
||||||
|
static readonly ERR_BAD_RESPONSE = "ERR_BAD_RESPONSE";
|
||||||
|
static readonly ERR_BAD_REQUEST = "ERR_BAD_REQUEST";
|
||||||
|
static readonly ERR_NOT_SUPPORT = "ERR_NOT_SUPPORT";
|
||||||
|
static readonly ERR_INVALID_URL = "ERR_INVALID_URL";
|
||||||
|
static readonly ERR_CANCELED = "ERR_CANCELED";
|
||||||
|
static readonly ECONNABORTED = "ECONNABORTED";
|
||||||
|
static readonly ETIMEDOUT = "ETIMEDOUT";
|
||||||
|
}
|
||||||
|
|
||||||
|
export class CanceledError<T> extends AxiosError<T> {
|
||||||
|
readonly name: "CanceledError";
|
||||||
|
}
|
||||||
|
|
||||||
|
export type AxiosPromise<T = any> = Promise<AxiosResponse<T>>;
|
||||||
|
|
||||||
|
export interface CancelStatic {
|
||||||
|
new (message?: string): Cancel;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Cancel {
|
||||||
|
message: string | undefined;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Canceler {
|
||||||
|
(message?: string, config?: AxiosRequestConfig, request?: any): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CancelTokenStatic {
|
||||||
|
new (executor: (cancel: Canceler) => void): CancelToken;
|
||||||
|
source(): CancelTokenSource;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CancelToken {
|
||||||
|
promise: Promise<Cancel>;
|
||||||
|
reason?: Cancel;
|
||||||
|
throwIfRequested(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface CancelTokenSource {
|
||||||
|
token: CancelToken;
|
||||||
|
cancel: Canceler;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AxiosInterceptorOptions {
|
||||||
|
synchronous?: boolean;
|
||||||
|
runWhen?: (config: InternalAxiosRequestConfig) => boolean;
|
||||||
|
}
|
||||||
|
|
||||||
|
type AxiosRequestInterceptorUse<T> = (onFulfilled?: ((value: T) => T | Promise<T>) | null, onRejected?: ((error: any) => any) | null, options?: AxiosInterceptorOptions) => number;
|
||||||
|
|
||||||
|
type AxiosResponseInterceptorUse<T> = (onFulfilled?: ((value: T) => T | Promise<T>) | null, onRejected?: ((error: any) => any) | null) => number;
|
||||||
|
|
||||||
|
export interface AxiosInterceptorManager<V> {
|
||||||
|
use: V extends AxiosResponse ? AxiosResponseInterceptorUse<V> : AxiosRequestInterceptorUse<V>;
|
||||||
|
eject(id: number): void;
|
||||||
|
clear(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export class Axios {
|
||||||
|
constructor(config?: AxiosRequestConfig);
|
||||||
|
defaults: AxiosDefaults;
|
||||||
|
interceptors: {
|
||||||
|
request: AxiosInterceptorManager<InternalAxiosRequestConfig>;
|
||||||
|
response: AxiosInterceptorManager<AxiosResponse>;
|
||||||
|
};
|
||||||
|
getUri(config?: AxiosRequestConfig): string;
|
||||||
|
request<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
get<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
delete<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
head<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
options<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
post<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
put<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
patch<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
postForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
putForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
patchForm<T = any, R = AxiosResponse<T>, D = any>(url: string, data?: D, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface AxiosInstance extends Axios {
|
||||||
|
<T = any, R = AxiosResponse<T>, D = any>(config: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
<T = any, R = AxiosResponse<T>, D = any>(url: string, config?: AxiosRequestConfig<D>): Promise<R>;
|
||||||
|
|
||||||
|
create(config?: CreateAxiosDefaults): AxiosInstance;
|
||||||
|
defaults: Omit<AxiosDefaults, 'headers'> & {
|
||||||
|
headers: HeadersDefaults & {
|
||||||
|
[key: string]: AxiosHeaderValue
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface GenericFormData {
|
||||||
|
append(name: string, value: any, options?: any): any;
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface GenericHTMLFormElement {
|
||||||
|
name: string;
|
||||||
|
method: string;
|
||||||
|
submit(): void;
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getAdapter(adapters: AxiosAdapterConfig | AxiosAdapterConfig[] | undefined): AxiosAdapter;
|
||||||
|
|
||||||
|
export function toFormData(sourceObj: object, targetFormData?: GenericFormData, options?: FormSerializerOptions): GenericFormData;
|
||||||
|
|
||||||
|
export function formToJSON(form: GenericFormData|GenericHTMLFormElement): object;
|
||||||
|
|
||||||
|
export function isAxiosError<T = any, D = any>(payload: any): payload is AxiosError<T, D>;
|
||||||
|
|
||||||
|
export function spread<T, R>(callback: (...args: T[]) => R): (array: T[]) => R;
|
||||||
|
|
||||||
|
export function isCancel<T = any>(value: any): value is CanceledError<T>;
|
||||||
|
|
||||||
|
export function all<T>(values: Array<T | Promise<T>>): Promise<T[]>;
|
||||||
|
|
||||||
|
export function mergeConfig<D = any>(config1: AxiosRequestConfig<D>, config2: AxiosRequestConfig<D>): AxiosRequestConfig<D>;
|
||||||
|
|
||||||
|
export interface AxiosStatic extends AxiosInstance {
|
||||||
|
Cancel: CancelStatic;
|
||||||
|
CancelToken: CancelTokenStatic;
|
||||||
|
Axios: typeof Axios;
|
||||||
|
AxiosError: typeof AxiosError;
|
||||||
|
HttpStatusCode: typeof HttpStatusCode;
|
||||||
|
readonly VERSION: string;
|
||||||
|
isCancel: typeof isCancel;
|
||||||
|
all: typeof all;
|
||||||
|
spread: typeof spread;
|
||||||
|
isAxiosError: typeof isAxiosError;
|
||||||
|
toFormData: typeof toFormData;
|
||||||
|
formToJSON: typeof formToJSON;
|
||||||
|
getAdapter: typeof getAdapter;
|
||||||
|
CanceledError: typeof CanceledError;
|
||||||
|
AxiosHeaders: typeof AxiosHeaders;
|
||||||
|
mergeConfig: typeof mergeConfig;
|
||||||
|
}
|
||||||
|
|
||||||
|
declare const axios: AxiosStatic;
|
||||||
|
|
||||||
|
export default axios;
|
||||||
|
|
@ -0,0 +1,43 @@
|
||||||
|
import axios from './lib/axios.js';
|
||||||
|
|
||||||
|
// This module is intended to unwrap Axios default export as named.
|
||||||
|
// Keep top-level export same with static properties
|
||||||
|
// so that it can keep same with es module or cjs
|
||||||
|
const {
|
||||||
|
Axios,
|
||||||
|
AxiosError,
|
||||||
|
CanceledError,
|
||||||
|
isCancel,
|
||||||
|
CancelToken,
|
||||||
|
VERSION,
|
||||||
|
all,
|
||||||
|
Cancel,
|
||||||
|
isAxiosError,
|
||||||
|
spread,
|
||||||
|
toFormData,
|
||||||
|
AxiosHeaders,
|
||||||
|
HttpStatusCode,
|
||||||
|
formToJSON,
|
||||||
|
getAdapter,
|
||||||
|
mergeConfig
|
||||||
|
} = axios;
|
||||||
|
|
||||||
|
export {
|
||||||
|
axios as default,
|
||||||
|
Axios,
|
||||||
|
AxiosError,
|
||||||
|
CanceledError,
|
||||||
|
isCancel,
|
||||||
|
CancelToken,
|
||||||
|
VERSION,
|
||||||
|
all,
|
||||||
|
Cancel,
|
||||||
|
isAxiosError,
|
||||||
|
spread,
|
||||||
|
toFormData,
|
||||||
|
AxiosHeaders,
|
||||||
|
HttpStatusCode,
|
||||||
|
formToJSON,
|
||||||
|
getAdapter,
|
||||||
|
mergeConfig
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,37 @@
|
||||||
|
# axios // adapters
|
||||||
|
|
||||||
|
The modules under `adapters/` are modules that handle dispatching a request and settling a returned `Promise` once a response is received.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
```js
|
||||||
|
var settle = require('./../core/settle');
|
||||||
|
|
||||||
|
module.exports = function myAdapter(config) {
|
||||||
|
// At this point:
|
||||||
|
// - config has been merged with defaults
|
||||||
|
// - request transformers have already run
|
||||||
|
// - request interceptors have already run
|
||||||
|
|
||||||
|
// Make the request using config provided
|
||||||
|
// Upon response settle the Promise
|
||||||
|
|
||||||
|
return new Promise(function(resolve, reject) {
|
||||||
|
|
||||||
|
var response = {
|
||||||
|
data: responseData,
|
||||||
|
status: request.status,
|
||||||
|
statusText: request.statusText,
|
||||||
|
headers: responseHeaders,
|
||||||
|
config: config,
|
||||||
|
request: request
|
||||||
|
};
|
||||||
|
|
||||||
|
settle(resolve, reject, response);
|
||||||
|
|
||||||
|
// From here:
|
||||||
|
// - response transformers will run
|
||||||
|
// - response interceptors will run
|
||||||
|
});
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
@ -0,0 +1,126 @@
|
||||||
|
import utils from '../utils.js';
|
||||||
|
import httpAdapter from './http.js';
|
||||||
|
import xhrAdapter from './xhr.js';
|
||||||
|
import * as fetchAdapter from './fetch.js';
|
||||||
|
import AxiosError from "../core/AxiosError.js";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Known adapters mapping.
|
||||||
|
* Provides environment-specific adapters for Axios:
|
||||||
|
* - `http` for Node.js
|
||||||
|
* - `xhr` for browsers
|
||||||
|
* - `fetch` for fetch API-based requests
|
||||||
|
*
|
||||||
|
* @type {Object<string, Function|Object>}
|
||||||
|
*/
|
||||||
|
const knownAdapters = {
|
||||||
|
http: httpAdapter,
|
||||||
|
xhr: xhrAdapter,
|
||||||
|
fetch: {
|
||||||
|
get: fetchAdapter.getFetch,
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Assign adapter names for easier debugging and identification
|
||||||
|
utils.forEach(knownAdapters, (fn, value) => {
|
||||||
|
if (fn) {
|
||||||
|
try {
|
||||||
|
Object.defineProperty(fn, 'name', { value });
|
||||||
|
} catch (e) {
|
||||||
|
// eslint-disable-next-line no-empty
|
||||||
|
}
|
||||||
|
Object.defineProperty(fn, 'adapterName', { value });
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Render a rejection reason string for unknown or unsupported adapters
|
||||||
|
*
|
||||||
|
* @param {string} reason
|
||||||
|
* @returns {string}
|
||||||
|
*/
|
||||||
|
const renderReason = (reason) => `- ${reason}`;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the adapter is resolved (function, null, or false)
|
||||||
|
*
|
||||||
|
* @param {Function|null|false} adapter
|
||||||
|
* @returns {boolean}
|
||||||
|
*/
|
||||||
|
const isResolvedHandle = (adapter) => utils.isFunction(adapter) || adapter === null || adapter === false;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the first suitable adapter from the provided list.
|
||||||
|
* Tries each adapter in order until a supported one is found.
|
||||||
|
* Throws an AxiosError if no adapter is suitable.
|
||||||
|
*
|
||||||
|
* @param {Array<string|Function>|string|Function} adapters - Adapter(s) by name or function.
|
||||||
|
* @param {Object} config - Axios request configuration
|
||||||
|
* @throws {AxiosError} If no suitable adapter is available
|
||||||
|
* @returns {Function} The resolved adapter function
|
||||||
|
*/
|
||||||
|
function getAdapter(adapters, config) {
|
||||||
|
adapters = utils.isArray(adapters) ? adapters : [adapters];
|
||||||
|
|
||||||
|
const { length } = adapters;
|
||||||
|
let nameOrAdapter;
|
||||||
|
let adapter;
|
||||||
|
|
||||||
|
const rejectedReasons = {};
|
||||||
|
|
||||||
|
for (let i = 0; i < length; i++) {
|
||||||
|
nameOrAdapter = adapters[i];
|
||||||
|
let id;
|
||||||
|
|
||||||
|
adapter = nameOrAdapter;
|
||||||
|
|
||||||
|
if (!isResolvedHandle(nameOrAdapter)) {
|
||||||
|
adapter = knownAdapters[(id = String(nameOrAdapter)).toLowerCase()];
|
||||||
|
|
||||||
|
if (adapter === undefined) {
|
||||||
|
throw new AxiosError(`Unknown adapter '${id}'`);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (adapter && (utils.isFunction(adapter) || (adapter = adapter.get(config)))) {
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
rejectedReasons[id || '#' + i] = adapter;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!adapter) {
|
||||||
|
const reasons = Object.entries(rejectedReasons)
|
||||||
|
.map(([id, state]) => `adapter ${id} ` +
|
||||||
|
(state === false ? 'is not supported by the environment' : 'is not available in the build')
|
||||||
|
);
|
||||||
|
|
||||||
|
let s = length ?
|
||||||
|
(reasons.length > 1 ? 'since :\n' + reasons.map(renderReason).join('\n') : ' ' + renderReason(reasons[0])) :
|
||||||
|
'as no adapter specified';
|
||||||
|
|
||||||
|
throw new AxiosError(
|
||||||
|
`There is no suitable adapter to dispatch the request ` + s,
|
||||||
|
'ERR_NOT_SUPPORT'
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
return adapter;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exports Axios adapters and utility to resolve an adapter
|
||||||
|
*/
|
||||||
|
export default {
|
||||||
|
/**
|
||||||
|
* Resolve an adapter from a list of adapter names or functions.
|
||||||
|
* @type {Function}
|
||||||
|
*/
|
||||||
|
getAdapter,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Exposes all known adapters
|
||||||
|
* @type {Object<string, Function|Object>}
|
||||||
|
*/
|
||||||
|
adapters: knownAdapters
|
||||||
|
};
|
||||||
|
|
@ -0,0 +1,288 @@
|
||||||
|
import platform from "../platform/index.js";
|
||||||
|
import utils from "../utils.js";
|
||||||
|
import AxiosError from "../core/AxiosError.js";
|
||||||
|
import composeSignals from "../helpers/composeSignals.js";
|
||||||
|
import {trackStream} from "../helpers/trackStream.js";
|
||||||
|
import AxiosHeaders from "../core/AxiosHeaders.js";
|
||||||
|
import {progressEventReducer, progressEventDecorator, asyncDecorator} from "../helpers/progressEventReducer.js";
|
||||||
|
import resolveConfig from "../helpers/resolveConfig.js";
|
||||||
|
import settle from "../core/settle.js";
|
||||||
|
|
||||||
|
const DEFAULT_CHUNK_SIZE = 64 * 1024;
|
||||||
|
|
||||||
|
const {isFunction} = utils;
|
||||||
|
|
||||||
|
const globalFetchAPI = (({Request, Response}) => ({
|
||||||
|
Request, Response
|
||||||
|
}))(utils.global);
|
||||||
|
|
||||||
|
const {
|
||||||
|
ReadableStream, TextEncoder
|
||||||
|
} = utils.global;
|
||||||
|
|
||||||
|
|
||||||
|
const test = (fn, ...args) => {
|
||||||
|
try {
|
||||||
|
return !!fn(...args);
|
||||||
|
} catch (e) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const factory = (env) => {
|
||||||
|
env = utils.merge.call({
|
||||||
|
skipUndefined: true
|
||||||
|
}, globalFetchAPI, env);
|
||||||
|
|
||||||
|
const {fetch: envFetch, Request, Response} = env;
|
||||||
|
const isFetchSupported = envFetch ? isFunction(envFetch) : typeof fetch === 'function';
|
||||||
|
const isRequestSupported = isFunction(Request);
|
||||||
|
const isResponseSupported = isFunction(Response);
|
||||||
|
|
||||||
|
if (!isFetchSupported) {
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const isReadableStreamSupported = isFetchSupported && isFunction(ReadableStream);
|
||||||
|
|
||||||
|
const encodeText = isFetchSupported && (typeof TextEncoder === 'function' ?
|
||||||
|
((encoder) => (str) => encoder.encode(str))(new TextEncoder()) :
|
||||||
|
async (str) => new Uint8Array(await new Request(str).arrayBuffer())
|
||||||
|
);
|
||||||
|
|
||||||
|
const supportsRequestStream = isRequestSupported && isReadableStreamSupported && test(() => {
|
||||||
|
let duplexAccessed = false;
|
||||||
|
|
||||||
|
const hasContentType = new Request(platform.origin, {
|
||||||
|
body: new ReadableStream(),
|
||||||
|
method: 'POST',
|
||||||
|
get duplex() {
|
||||||
|
duplexAccessed = true;
|
||||||
|
return 'half';
|
||||||
|
},
|
||||||
|
}).headers.has('Content-Type');
|
||||||
|
|
||||||
|
return duplexAccessed && !hasContentType;
|
||||||
|
});
|
||||||
|
|
||||||
|
const supportsResponseStream = isResponseSupported && isReadableStreamSupported &&
|
||||||
|
test(() => utils.isReadableStream(new Response('').body));
|
||||||
|
|
||||||
|
const resolvers = {
|
||||||
|
stream: supportsResponseStream && ((res) => res.body)
|
||||||
|
};
|
||||||
|
|
||||||
|
isFetchSupported && ((() => {
|
||||||
|
['text', 'arrayBuffer', 'blob', 'formData', 'stream'].forEach(type => {
|
||||||
|
!resolvers[type] && (resolvers[type] = (res, config) => {
|
||||||
|
let method = res && res[type];
|
||||||
|
|
||||||
|
if (method) {
|
||||||
|
return method.call(res);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new AxiosError(`Response type '${type}' is not supported`, AxiosError.ERR_NOT_SUPPORT, config);
|
||||||
|
})
|
||||||
|
});
|
||||||
|
})());
|
||||||
|
|
||||||
|
const getBodyLength = async (body) => {
|
||||||
|
if (body == null) {
|
||||||
|
return 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isBlob(body)) {
|
||||||
|
return body.size;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isSpecCompliantForm(body)) {
|
||||||
|
const _request = new Request(platform.origin, {
|
||||||
|
method: 'POST',
|
||||||
|
body,
|
||||||
|
});
|
||||||
|
return (await _request.arrayBuffer()).byteLength;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isArrayBufferView(body) || utils.isArrayBuffer(body)) {
|
||||||
|
return body.byteLength;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isURLSearchParams(body)) {
|
||||||
|
body = body + '';
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isString(body)) {
|
||||||
|
return (await encodeText(body)).byteLength;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const resolveBodyLength = async (headers, body) => {
|
||||||
|
const length = utils.toFiniteNumber(headers.getContentLength());
|
||||||
|
|
||||||
|
return length == null ? getBodyLength(body) : length;
|
||||||
|
}
|
||||||
|
|
||||||
|
return async (config) => {
|
||||||
|
let {
|
||||||
|
url,
|
||||||
|
method,
|
||||||
|
data,
|
||||||
|
signal,
|
||||||
|
cancelToken,
|
||||||
|
timeout,
|
||||||
|
onDownloadProgress,
|
||||||
|
onUploadProgress,
|
||||||
|
responseType,
|
||||||
|
headers,
|
||||||
|
withCredentials = 'same-origin',
|
||||||
|
fetchOptions
|
||||||
|
} = resolveConfig(config);
|
||||||
|
|
||||||
|
let _fetch = envFetch || fetch;
|
||||||
|
|
||||||
|
responseType = responseType ? (responseType + '').toLowerCase() : 'text';
|
||||||
|
|
||||||
|
let composedSignal = composeSignals([signal, cancelToken && cancelToken.toAbortSignal()], timeout);
|
||||||
|
|
||||||
|
let request = null;
|
||||||
|
|
||||||
|
const unsubscribe = composedSignal && composedSignal.unsubscribe && (() => {
|
||||||
|
composedSignal.unsubscribe();
|
||||||
|
});
|
||||||
|
|
||||||
|
let requestContentLength;
|
||||||
|
|
||||||
|
try {
|
||||||
|
if (
|
||||||
|
onUploadProgress && supportsRequestStream && method !== 'get' && method !== 'head' &&
|
||||||
|
(requestContentLength = await resolveBodyLength(headers, data)) !== 0
|
||||||
|
) {
|
||||||
|
let _request = new Request(url, {
|
||||||
|
method: 'POST',
|
||||||
|
body: data,
|
||||||
|
duplex: "half"
|
||||||
|
});
|
||||||
|
|
||||||
|
let contentTypeHeader;
|
||||||
|
|
||||||
|
if (utils.isFormData(data) && (contentTypeHeader = _request.headers.get('content-type'))) {
|
||||||
|
headers.setContentType(contentTypeHeader)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_request.body) {
|
||||||
|
const [onProgress, flush] = progressEventDecorator(
|
||||||
|
requestContentLength,
|
||||||
|
progressEventReducer(asyncDecorator(onUploadProgress))
|
||||||
|
);
|
||||||
|
|
||||||
|
data = trackStream(_request.body, DEFAULT_CHUNK_SIZE, onProgress, flush);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!utils.isString(withCredentials)) {
|
||||||
|
withCredentials = withCredentials ? 'include' : 'omit';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Cloudflare Workers throws when credentials are defined
|
||||||
|
// see https://github.com/cloudflare/workerd/issues/902
|
||||||
|
const isCredentialsSupported = isRequestSupported && "credentials" in Request.prototype;
|
||||||
|
|
||||||
|
const resolvedOptions = {
|
||||||
|
...fetchOptions,
|
||||||
|
signal: composedSignal,
|
||||||
|
method: method.toUpperCase(),
|
||||||
|
headers: headers.normalize().toJSON(),
|
||||||
|
body: data,
|
||||||
|
duplex: "half",
|
||||||
|
credentials: isCredentialsSupported ? withCredentials : undefined
|
||||||
|
};
|
||||||
|
|
||||||
|
request = isRequestSupported && new Request(url, resolvedOptions);
|
||||||
|
|
||||||
|
let response = await (isRequestSupported ? _fetch(request, fetchOptions) : _fetch(url, resolvedOptions));
|
||||||
|
|
||||||
|
const isStreamResponse = supportsResponseStream && (responseType === 'stream' || responseType === 'response');
|
||||||
|
|
||||||
|
if (supportsResponseStream && (onDownloadProgress || (isStreamResponse && unsubscribe))) {
|
||||||
|
const options = {};
|
||||||
|
|
||||||
|
['status', 'statusText', 'headers'].forEach(prop => {
|
||||||
|
options[prop] = response[prop];
|
||||||
|
});
|
||||||
|
|
||||||
|
const responseContentLength = utils.toFiniteNumber(response.headers.get('content-length'));
|
||||||
|
|
||||||
|
const [onProgress, flush] = onDownloadProgress && progressEventDecorator(
|
||||||
|
responseContentLength,
|
||||||
|
progressEventReducer(asyncDecorator(onDownloadProgress), true)
|
||||||
|
) || [];
|
||||||
|
|
||||||
|
response = new Response(
|
||||||
|
trackStream(response.body, DEFAULT_CHUNK_SIZE, onProgress, () => {
|
||||||
|
flush && flush();
|
||||||
|
unsubscribe && unsubscribe();
|
||||||
|
}),
|
||||||
|
options
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
responseType = responseType || 'text';
|
||||||
|
|
||||||
|
let responseData = await resolvers[utils.findKey(resolvers, responseType) || 'text'](response, config);
|
||||||
|
|
||||||
|
!isStreamResponse && unsubscribe && unsubscribe();
|
||||||
|
|
||||||
|
return await new Promise((resolve, reject) => {
|
||||||
|
settle(resolve, reject, {
|
||||||
|
data: responseData,
|
||||||
|
headers: AxiosHeaders.from(response.headers),
|
||||||
|
status: response.status,
|
||||||
|
statusText: response.statusText,
|
||||||
|
config,
|
||||||
|
request
|
||||||
|
})
|
||||||
|
})
|
||||||
|
} catch (err) {
|
||||||
|
unsubscribe && unsubscribe();
|
||||||
|
|
||||||
|
if (err && err.name === 'TypeError' && /Load failed|fetch/i.test(err.message)) {
|
||||||
|
throw Object.assign(
|
||||||
|
new AxiosError('Network Error', AxiosError.ERR_NETWORK, config, request),
|
||||||
|
{
|
||||||
|
cause: err.cause || err
|
||||||
|
}
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
throw AxiosError.from(err, err && err.code, config, request);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const seedCache = new Map();
|
||||||
|
|
||||||
|
export const getFetch = (config) => {
|
||||||
|
let env = (config && config.env) || {};
|
||||||
|
const {fetch, Request, Response} = env;
|
||||||
|
const seeds = [
|
||||||
|
Request, Response, fetch
|
||||||
|
];
|
||||||
|
|
||||||
|
let len = seeds.length, i = len,
|
||||||
|
seed, target, map = seedCache;
|
||||||
|
|
||||||
|
while (i--) {
|
||||||
|
seed = seeds[i];
|
||||||
|
target = map.get(seed);
|
||||||
|
|
||||||
|
target === undefined && map.set(seed, target = (i ? new Map() : factory(env)))
|
||||||
|
|
||||||
|
map = target;
|
||||||
|
}
|
||||||
|
|
||||||
|
return target;
|
||||||
|
};
|
||||||
|
|
||||||
|
const adapter = getFetch();
|
||||||
|
|
||||||
|
export default adapter;
|
||||||
|
|
@ -0,0 +1,895 @@
|
||||||
|
import utils from './../utils.js';
|
||||||
|
import settle from './../core/settle.js';
|
||||||
|
import buildFullPath from '../core/buildFullPath.js';
|
||||||
|
import buildURL from './../helpers/buildURL.js';
|
||||||
|
import proxyFromEnv from 'proxy-from-env';
|
||||||
|
import http from 'http';
|
||||||
|
import https from 'https';
|
||||||
|
import http2 from 'http2';
|
||||||
|
import util from 'util';
|
||||||
|
import followRedirects from 'follow-redirects';
|
||||||
|
import zlib from 'zlib';
|
||||||
|
import {VERSION} from '../env/data.js';
|
||||||
|
import transitionalDefaults from '../defaults/transitional.js';
|
||||||
|
import AxiosError from '../core/AxiosError.js';
|
||||||
|
import CanceledError from '../cancel/CanceledError.js';
|
||||||
|
import platform from '../platform/index.js';
|
||||||
|
import fromDataURI from '../helpers/fromDataURI.js';
|
||||||
|
import stream from 'stream';
|
||||||
|
import AxiosHeaders from '../core/AxiosHeaders.js';
|
||||||
|
import AxiosTransformStream from '../helpers/AxiosTransformStream.js';
|
||||||
|
import {EventEmitter} from 'events';
|
||||||
|
import formDataToStream from "../helpers/formDataToStream.js";
|
||||||
|
import readBlob from "../helpers/readBlob.js";
|
||||||
|
import ZlibHeaderTransformStream from '../helpers/ZlibHeaderTransformStream.js';
|
||||||
|
import callbackify from "../helpers/callbackify.js";
|
||||||
|
import {progressEventReducer, progressEventDecorator, asyncDecorator} from "../helpers/progressEventReducer.js";
|
||||||
|
import estimateDataURLDecodedBytes from '../helpers/estimateDataURLDecodedBytes.js';
|
||||||
|
|
||||||
|
const zlibOptions = {
|
||||||
|
flush: zlib.constants.Z_SYNC_FLUSH,
|
||||||
|
finishFlush: zlib.constants.Z_SYNC_FLUSH
|
||||||
|
};
|
||||||
|
|
||||||
|
const brotliOptions = {
|
||||||
|
flush: zlib.constants.BROTLI_OPERATION_FLUSH,
|
||||||
|
finishFlush: zlib.constants.BROTLI_OPERATION_FLUSH
|
||||||
|
}
|
||||||
|
|
||||||
|
const isBrotliSupported = utils.isFunction(zlib.createBrotliDecompress);
|
||||||
|
|
||||||
|
const {http: httpFollow, https: httpsFollow} = followRedirects;
|
||||||
|
|
||||||
|
const isHttps = /https:?/;
|
||||||
|
|
||||||
|
const supportedProtocols = platform.protocols.map(protocol => {
|
||||||
|
return protocol + ':';
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
const flushOnFinish = (stream, [throttled, flush]) => {
|
||||||
|
stream
|
||||||
|
.on('end', flush)
|
||||||
|
.on('error', flush);
|
||||||
|
|
||||||
|
return throttled;
|
||||||
|
}
|
||||||
|
|
||||||
|
class Http2Sessions {
|
||||||
|
constructor() {
|
||||||
|
this.sessions = Object.create(null);
|
||||||
|
}
|
||||||
|
|
||||||
|
getSession(authority, options) {
|
||||||
|
options = Object.assign({
|
||||||
|
sessionTimeout: 1000
|
||||||
|
}, options);
|
||||||
|
|
||||||
|
let authoritySessions = this.sessions[authority];
|
||||||
|
|
||||||
|
if (authoritySessions) {
|
||||||
|
let len = authoritySessions.length;
|
||||||
|
|
||||||
|
for (let i = 0; i < len; i++) {
|
||||||
|
const [sessionHandle, sessionOptions] = authoritySessions[i];
|
||||||
|
if (!sessionHandle.destroyed && !sessionHandle.closed && util.isDeepStrictEqual(sessionOptions, options)) {
|
||||||
|
return sessionHandle;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const session = http2.connect(authority, options);
|
||||||
|
|
||||||
|
let removed;
|
||||||
|
|
||||||
|
const removeSession = () => {
|
||||||
|
if (removed) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
removed = true;
|
||||||
|
|
||||||
|
let entries = authoritySessions, len = entries.length, i = len;
|
||||||
|
|
||||||
|
while (i--) {
|
||||||
|
if (entries[i][0] === session) {
|
||||||
|
if (len === 1) {
|
||||||
|
delete this.sessions[authority];
|
||||||
|
} else {
|
||||||
|
entries.splice(i, 1);
|
||||||
|
}
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
const originalRequestFn = session.request;
|
||||||
|
|
||||||
|
const {sessionTimeout} = options;
|
||||||
|
|
||||||
|
if(sessionTimeout != null) {
|
||||||
|
|
||||||
|
let timer;
|
||||||
|
let streamsCount = 0;
|
||||||
|
|
||||||
|
session.request = function () {
|
||||||
|
const stream = originalRequestFn.apply(this, arguments);
|
||||||
|
|
||||||
|
streamsCount++;
|
||||||
|
|
||||||
|
if (timer) {
|
||||||
|
clearTimeout(timer);
|
||||||
|
timer = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
stream.once('close', () => {
|
||||||
|
if (!--streamsCount) {
|
||||||
|
timer = setTimeout(() => {
|
||||||
|
timer = null;
|
||||||
|
removeSession();
|
||||||
|
}, sessionTimeout);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
return stream;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
session.once('close', removeSession);
|
||||||
|
|
||||||
|
let entry = [
|
||||||
|
session,
|
||||||
|
options
|
||||||
|
];
|
||||||
|
|
||||||
|
authoritySessions ? authoritySessions.push(entry) : authoritySessions = this.sessions[authority] = [entry];
|
||||||
|
|
||||||
|
return session;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const http2Sessions = new Http2Sessions();
|
||||||
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the proxy or config beforeRedirects functions are defined, call them with the options
|
||||||
|
* object.
|
||||||
|
*
|
||||||
|
* @param {Object<string, any>} options - The options object that was passed to the request.
|
||||||
|
*
|
||||||
|
* @returns {Object<string, any>}
|
||||||
|
*/
|
||||||
|
function dispatchBeforeRedirect(options, responseDetails) {
|
||||||
|
if (options.beforeRedirects.proxy) {
|
||||||
|
options.beforeRedirects.proxy(options);
|
||||||
|
}
|
||||||
|
if (options.beforeRedirects.config) {
|
||||||
|
options.beforeRedirects.config(options, responseDetails);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the proxy or config afterRedirects functions are defined, call them with the options
|
||||||
|
*
|
||||||
|
* @param {http.ClientRequestArgs} options
|
||||||
|
* @param {AxiosProxyConfig} configProxy configuration from Axios options object
|
||||||
|
* @param {string} location
|
||||||
|
*
|
||||||
|
* @returns {http.ClientRequestArgs}
|
||||||
|
*/
|
||||||
|
function setProxy(options, configProxy, location) {
|
||||||
|
let proxy = configProxy;
|
||||||
|
if (!proxy && proxy !== false) {
|
||||||
|
const proxyUrl = proxyFromEnv.getProxyForUrl(location);
|
||||||
|
if (proxyUrl) {
|
||||||
|
proxy = new URL(proxyUrl);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if (proxy) {
|
||||||
|
// Basic proxy authorization
|
||||||
|
if (proxy.username) {
|
||||||
|
proxy.auth = (proxy.username || '') + ':' + (proxy.password || '');
|
||||||
|
}
|
||||||
|
|
||||||
|
if (proxy.auth) {
|
||||||
|
// Support proxy auth object form
|
||||||
|
if (proxy.auth.username || proxy.auth.password) {
|
||||||
|
proxy.auth = (proxy.auth.username || '') + ':' + (proxy.auth.password || '');
|
||||||
|
}
|
||||||
|
const base64 = Buffer
|
||||||
|
.from(proxy.auth, 'utf8')
|
||||||
|
.toString('base64');
|
||||||
|
options.headers['Proxy-Authorization'] = 'Basic ' + base64;
|
||||||
|
}
|
||||||
|
|
||||||
|
options.headers.host = options.hostname + (options.port ? ':' + options.port : '');
|
||||||
|
const proxyHost = proxy.hostname || proxy.host;
|
||||||
|
options.hostname = proxyHost;
|
||||||
|
// Replace 'host' since options is not a URL object
|
||||||
|
options.host = proxyHost;
|
||||||
|
options.port = proxy.port;
|
||||||
|
options.path = location;
|
||||||
|
if (proxy.protocol) {
|
||||||
|
options.protocol = proxy.protocol.includes(':') ? proxy.protocol : `${proxy.protocol}:`;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
options.beforeRedirects.proxy = function beforeRedirect(redirectOptions) {
|
||||||
|
// Configure proxy for redirected request, passing the original config proxy to apply
|
||||||
|
// the exact same logic as if the redirected request was performed by axios directly.
|
||||||
|
setProxy(redirectOptions, configProxy, redirectOptions.href);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
const isHttpAdapterSupported = typeof process !== 'undefined' && utils.kindOf(process) === 'process';
|
||||||
|
|
||||||
|
// temporary hotfix
|
||||||
|
|
||||||
|
const wrapAsync = (asyncExecutor) => {
|
||||||
|
return new Promise((resolve, reject) => {
|
||||||
|
let onDone;
|
||||||
|
let isDone;
|
||||||
|
|
||||||
|
const done = (value, isRejected) => {
|
||||||
|
if (isDone) return;
|
||||||
|
isDone = true;
|
||||||
|
onDone && onDone(value, isRejected);
|
||||||
|
}
|
||||||
|
|
||||||
|
const _resolve = (value) => {
|
||||||
|
done(value);
|
||||||
|
resolve(value);
|
||||||
|
};
|
||||||
|
|
||||||
|
const _reject = (reason) => {
|
||||||
|
done(reason, true);
|
||||||
|
reject(reason);
|
||||||
|
}
|
||||||
|
|
||||||
|
asyncExecutor(_resolve, _reject, (onDoneHandler) => (onDone = onDoneHandler)).catch(_reject);
|
||||||
|
})
|
||||||
|
};
|
||||||
|
|
||||||
|
const resolveFamily = ({address, family}) => {
|
||||||
|
if (!utils.isString(address)) {
|
||||||
|
throw TypeError('address must be a string');
|
||||||
|
}
|
||||||
|
return ({
|
||||||
|
address,
|
||||||
|
family: family || (address.indexOf('.') < 0 ? 6 : 4)
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
const buildAddressEntry = (address, family) => resolveFamily(utils.isObject(address) ? address : {address, family});
|
||||||
|
|
||||||
|
const http2Transport = {
|
||||||
|
request(options, cb) {
|
||||||
|
const authority = options.protocol + '//' + options.hostname + ':' + (options.port || 80);
|
||||||
|
|
||||||
|
const {http2Options, headers} = options;
|
||||||
|
|
||||||
|
const session = http2Sessions.getSession(authority, http2Options);
|
||||||
|
|
||||||
|
const {
|
||||||
|
HTTP2_HEADER_SCHEME,
|
||||||
|
HTTP2_HEADER_METHOD,
|
||||||
|
HTTP2_HEADER_PATH,
|
||||||
|
HTTP2_HEADER_STATUS
|
||||||
|
} = http2.constants;
|
||||||
|
|
||||||
|
const http2Headers = {
|
||||||
|
[HTTP2_HEADER_SCHEME]: options.protocol.replace(':', ''),
|
||||||
|
[HTTP2_HEADER_METHOD]: options.method,
|
||||||
|
[HTTP2_HEADER_PATH]: options.path,
|
||||||
|
}
|
||||||
|
|
||||||
|
utils.forEach(headers, (header, name) => {
|
||||||
|
name.charAt(0) !== ':' && (http2Headers[name] = header);
|
||||||
|
});
|
||||||
|
|
||||||
|
const req = session.request(http2Headers);
|
||||||
|
|
||||||
|
req.once('response', (responseHeaders) => {
|
||||||
|
const response = req; //duplex
|
||||||
|
|
||||||
|
responseHeaders = Object.assign({}, responseHeaders);
|
||||||
|
|
||||||
|
const status = responseHeaders[HTTP2_HEADER_STATUS];
|
||||||
|
|
||||||
|
delete responseHeaders[HTTP2_HEADER_STATUS];
|
||||||
|
|
||||||
|
response.headers = responseHeaders;
|
||||||
|
|
||||||
|
response.statusCode = +status;
|
||||||
|
|
||||||
|
cb(response);
|
||||||
|
})
|
||||||
|
|
||||||
|
return req;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*eslint consistent-return:0*/
|
||||||
|
export default isHttpAdapterSupported && function httpAdapter(config) {
|
||||||
|
return wrapAsync(async function dispatchHttpRequest(resolve, reject, onDone) {
|
||||||
|
let {data, lookup, family, httpVersion = 1, http2Options} = config;
|
||||||
|
const {responseType, responseEncoding} = config;
|
||||||
|
const method = config.method.toUpperCase();
|
||||||
|
let isDone;
|
||||||
|
let rejected = false;
|
||||||
|
let req;
|
||||||
|
|
||||||
|
httpVersion = +httpVersion;
|
||||||
|
|
||||||
|
if (Number.isNaN(httpVersion)) {
|
||||||
|
throw TypeError(`Invalid protocol version: '${config.httpVersion}' is not a number`);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (httpVersion !== 1 && httpVersion !== 2) {
|
||||||
|
throw TypeError(`Unsupported protocol version '${httpVersion}'`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const isHttp2 = httpVersion === 2;
|
||||||
|
|
||||||
|
if (lookup) {
|
||||||
|
const _lookup = callbackify(lookup, (value) => utils.isArray(value) ? value : [value]);
|
||||||
|
// hotfix to support opt.all option which is required for node 20.x
|
||||||
|
lookup = (hostname, opt, cb) => {
|
||||||
|
_lookup(hostname, opt, (err, arg0, arg1) => {
|
||||||
|
if (err) {
|
||||||
|
return cb(err);
|
||||||
|
}
|
||||||
|
|
||||||
|
const addresses = utils.isArray(arg0) ? arg0.map(addr => buildAddressEntry(addr)) : [buildAddressEntry(arg0, arg1)];
|
||||||
|
|
||||||
|
opt.all ? cb(err, addresses) : cb(err, addresses[0].address, addresses[0].family);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const abortEmitter = new EventEmitter();
|
||||||
|
|
||||||
|
function abort(reason) {
|
||||||
|
try {
|
||||||
|
abortEmitter.emit('abort', !reason || reason.type ? new CanceledError(null, config, req) : reason);
|
||||||
|
} catch(err) {
|
||||||
|
console.warn('emit error', err);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
abortEmitter.once('abort', reject);
|
||||||
|
|
||||||
|
const onFinished = () => {
|
||||||
|
if (config.cancelToken) {
|
||||||
|
config.cancelToken.unsubscribe(abort);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (config.signal) {
|
||||||
|
config.signal.removeEventListener('abort', abort);
|
||||||
|
}
|
||||||
|
|
||||||
|
abortEmitter.removeAllListeners();
|
||||||
|
}
|
||||||
|
|
||||||
|
if (config.cancelToken || config.signal) {
|
||||||
|
config.cancelToken && config.cancelToken.subscribe(abort);
|
||||||
|
if (config.signal) {
|
||||||
|
config.signal.aborted ? abort() : config.signal.addEventListener('abort', abort);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
onDone((response, isRejected) => {
|
||||||
|
isDone = true;
|
||||||
|
|
||||||
|
if (isRejected) {
|
||||||
|
rejected = true;
|
||||||
|
onFinished();
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const {data} = response;
|
||||||
|
|
||||||
|
if (data instanceof stream.Readable || data instanceof stream.Duplex) {
|
||||||
|
const offListeners = stream.finished(data, () => {
|
||||||
|
offListeners();
|
||||||
|
onFinished();
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
onFinished();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
// Parse url
|
||||||
|
const fullPath = buildFullPath(config.baseURL, config.url, config.allowAbsoluteUrls);
|
||||||
|
const parsed = new URL(fullPath, platform.hasBrowserEnv ? platform.origin : undefined);
|
||||||
|
const protocol = parsed.protocol || supportedProtocols[0];
|
||||||
|
|
||||||
|
if (protocol === 'data:') {
|
||||||
|
// Apply the same semantics as HTTP: only enforce if a finite, non-negative cap is set.
|
||||||
|
if (config.maxContentLength > -1) {
|
||||||
|
// Use the exact string passed to fromDataURI (config.url); fall back to fullPath if needed.
|
||||||
|
const dataUrl = String(config.url || fullPath || '');
|
||||||
|
const estimated = estimateDataURLDecodedBytes(dataUrl);
|
||||||
|
|
||||||
|
if (estimated > config.maxContentLength) {
|
||||||
|
return reject(new AxiosError(
|
||||||
|
'maxContentLength size of ' + config.maxContentLength + ' exceeded',
|
||||||
|
AxiosError.ERR_BAD_RESPONSE,
|
||||||
|
config
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let convertedData;
|
||||||
|
|
||||||
|
if (method !== 'GET') {
|
||||||
|
return settle(resolve, reject, {
|
||||||
|
status: 405,
|
||||||
|
statusText: 'method not allowed',
|
||||||
|
headers: {},
|
||||||
|
config
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
convertedData = fromDataURI(config.url, responseType === 'blob', {
|
||||||
|
Blob: config.env && config.env.Blob
|
||||||
|
});
|
||||||
|
} catch (err) {
|
||||||
|
throw AxiosError.from(err, AxiosError.ERR_BAD_REQUEST, config);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (responseType === 'text') {
|
||||||
|
convertedData = convertedData.toString(responseEncoding);
|
||||||
|
|
||||||
|
if (!responseEncoding || responseEncoding === 'utf8') {
|
||||||
|
convertedData = utils.stripBOM(convertedData);
|
||||||
|
}
|
||||||
|
} else if (responseType === 'stream') {
|
||||||
|
convertedData = stream.Readable.from(convertedData);
|
||||||
|
}
|
||||||
|
|
||||||
|
return settle(resolve, reject, {
|
||||||
|
data: convertedData,
|
||||||
|
status: 200,
|
||||||
|
statusText: 'OK',
|
||||||
|
headers: new AxiosHeaders(),
|
||||||
|
config
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
if (supportedProtocols.indexOf(protocol) === -1) {
|
||||||
|
return reject(new AxiosError(
|
||||||
|
'Unsupported protocol ' + protocol,
|
||||||
|
AxiosError.ERR_BAD_REQUEST,
|
||||||
|
config
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
const headers = AxiosHeaders.from(config.headers).normalize();
|
||||||
|
|
||||||
|
// Set User-Agent (required by some servers)
|
||||||
|
// See https://github.com/axios/axios/issues/69
|
||||||
|
// User-Agent is specified; handle case where no UA header is desired
|
||||||
|
// Only set header if it hasn't been set in config
|
||||||
|
headers.set('User-Agent', 'axios/' + VERSION, false);
|
||||||
|
|
||||||
|
const {onUploadProgress, onDownloadProgress} = config;
|
||||||
|
const maxRate = config.maxRate;
|
||||||
|
let maxUploadRate = undefined;
|
||||||
|
let maxDownloadRate = undefined;
|
||||||
|
|
||||||
|
// support for spec compliant FormData objects
|
||||||
|
if (utils.isSpecCompliantForm(data)) {
|
||||||
|
const userBoundary = headers.getContentType(/boundary=([-_\w\d]{10,70})/i);
|
||||||
|
|
||||||
|
data = formDataToStream(data, (formHeaders) => {
|
||||||
|
headers.set(formHeaders);
|
||||||
|
}, {
|
||||||
|
tag: `axios-${VERSION}-boundary`,
|
||||||
|
boundary: userBoundary && userBoundary[1] || undefined
|
||||||
|
});
|
||||||
|
// support for https://www.npmjs.com/package/form-data api
|
||||||
|
} else if (utils.isFormData(data) && utils.isFunction(data.getHeaders)) {
|
||||||
|
headers.set(data.getHeaders());
|
||||||
|
|
||||||
|
if (!headers.hasContentLength()) {
|
||||||
|
try {
|
||||||
|
const knownLength = await util.promisify(data.getLength).call(data);
|
||||||
|
Number.isFinite(knownLength) && knownLength >= 0 && headers.setContentLength(knownLength);
|
||||||
|
/*eslint no-empty:0*/
|
||||||
|
} catch (e) {
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} else if (utils.isBlob(data) || utils.isFile(data)) {
|
||||||
|
data.size && headers.setContentType(data.type || 'application/octet-stream');
|
||||||
|
headers.setContentLength(data.size || 0);
|
||||||
|
data = stream.Readable.from(readBlob(data));
|
||||||
|
} else if (data && !utils.isStream(data)) {
|
||||||
|
if (Buffer.isBuffer(data)) {
|
||||||
|
// Nothing to do...
|
||||||
|
} else if (utils.isArrayBuffer(data)) {
|
||||||
|
data = Buffer.from(new Uint8Array(data));
|
||||||
|
} else if (utils.isString(data)) {
|
||||||
|
data = Buffer.from(data, 'utf-8');
|
||||||
|
} else {
|
||||||
|
return reject(new AxiosError(
|
||||||
|
'Data after transformation must be a string, an ArrayBuffer, a Buffer, or a Stream',
|
||||||
|
AxiosError.ERR_BAD_REQUEST,
|
||||||
|
config
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add Content-Length header if data exists
|
||||||
|
headers.setContentLength(data.length, false);
|
||||||
|
|
||||||
|
if (config.maxBodyLength > -1 && data.length > config.maxBodyLength) {
|
||||||
|
return reject(new AxiosError(
|
||||||
|
'Request body larger than maxBodyLength limit',
|
||||||
|
AxiosError.ERR_BAD_REQUEST,
|
||||||
|
config
|
||||||
|
));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const contentLength = utils.toFiniteNumber(headers.getContentLength());
|
||||||
|
|
||||||
|
if (utils.isArray(maxRate)) {
|
||||||
|
maxUploadRate = maxRate[0];
|
||||||
|
maxDownloadRate = maxRate[1];
|
||||||
|
} else {
|
||||||
|
maxUploadRate = maxDownloadRate = maxRate;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (data && (onUploadProgress || maxUploadRate)) {
|
||||||
|
if (!utils.isStream(data)) {
|
||||||
|
data = stream.Readable.from(data, {objectMode: false});
|
||||||
|
}
|
||||||
|
|
||||||
|
data = stream.pipeline([data, new AxiosTransformStream({
|
||||||
|
maxRate: utils.toFiniteNumber(maxUploadRate)
|
||||||
|
})], utils.noop);
|
||||||
|
|
||||||
|
onUploadProgress && data.on('progress', flushOnFinish(
|
||||||
|
data,
|
||||||
|
progressEventDecorator(
|
||||||
|
contentLength,
|
||||||
|
progressEventReducer(asyncDecorator(onUploadProgress), false, 3)
|
||||||
|
)
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
// HTTP basic authentication
|
||||||
|
let auth = undefined;
|
||||||
|
if (config.auth) {
|
||||||
|
const username = config.auth.username || '';
|
||||||
|
const password = config.auth.password || '';
|
||||||
|
auth = username + ':' + password;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!auth && parsed.username) {
|
||||||
|
const urlUsername = parsed.username;
|
||||||
|
const urlPassword = parsed.password;
|
||||||
|
auth = urlUsername + ':' + urlPassword;
|
||||||
|
}
|
||||||
|
|
||||||
|
auth && headers.delete('authorization');
|
||||||
|
|
||||||
|
let path;
|
||||||
|
|
||||||
|
try {
|
||||||
|
path = buildURL(
|
||||||
|
parsed.pathname + parsed.search,
|
||||||
|
config.params,
|
||||||
|
config.paramsSerializer
|
||||||
|
).replace(/^\?/, '');
|
||||||
|
} catch (err) {
|
||||||
|
const customErr = new Error(err.message);
|
||||||
|
customErr.config = config;
|
||||||
|
customErr.url = config.url;
|
||||||
|
customErr.exists = true;
|
||||||
|
return reject(customErr);
|
||||||
|
}
|
||||||
|
|
||||||
|
headers.set(
|
||||||
|
'Accept-Encoding',
|
||||||
|
'gzip, compress, deflate' + (isBrotliSupported ? ', br' : ''), false
|
||||||
|
);
|
||||||
|
|
||||||
|
const options = {
|
||||||
|
path,
|
||||||
|
method: method,
|
||||||
|
headers: headers.toJSON(),
|
||||||
|
agents: { http: config.httpAgent, https: config.httpsAgent },
|
||||||
|
auth,
|
||||||
|
protocol,
|
||||||
|
family,
|
||||||
|
beforeRedirect: dispatchBeforeRedirect,
|
||||||
|
beforeRedirects: {},
|
||||||
|
http2Options
|
||||||
|
};
|
||||||
|
|
||||||
|
// cacheable-lookup integration hotfix
|
||||||
|
!utils.isUndefined(lookup) && (options.lookup = lookup);
|
||||||
|
|
||||||
|
if (config.socketPath) {
|
||||||
|
options.socketPath = config.socketPath;
|
||||||
|
} else {
|
||||||
|
options.hostname = parsed.hostname.startsWith("[") ? parsed.hostname.slice(1, -1) : parsed.hostname;
|
||||||
|
options.port = parsed.port;
|
||||||
|
setProxy(options, config.proxy, protocol + '//' + parsed.hostname + (parsed.port ? ':' + parsed.port : '') + options.path);
|
||||||
|
}
|
||||||
|
|
||||||
|
let transport;
|
||||||
|
const isHttpsRequest = isHttps.test(options.protocol);
|
||||||
|
options.agent = isHttpsRequest ? config.httpsAgent : config.httpAgent;
|
||||||
|
|
||||||
|
if (isHttp2) {
|
||||||
|
transport = http2Transport;
|
||||||
|
} else {
|
||||||
|
if (config.transport) {
|
||||||
|
transport = config.transport;
|
||||||
|
} else if (config.maxRedirects === 0) {
|
||||||
|
transport = isHttpsRequest ? https : http;
|
||||||
|
} else {
|
||||||
|
if (config.maxRedirects) {
|
||||||
|
options.maxRedirects = config.maxRedirects;
|
||||||
|
}
|
||||||
|
if (config.beforeRedirect) {
|
||||||
|
options.beforeRedirects.config = config.beforeRedirect;
|
||||||
|
}
|
||||||
|
transport = isHttpsRequest ? httpsFollow : httpFollow;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (config.maxBodyLength > -1) {
|
||||||
|
options.maxBodyLength = config.maxBodyLength;
|
||||||
|
} else {
|
||||||
|
// follow-redirects does not skip comparison, so it should always succeed for axios -1 unlimited
|
||||||
|
options.maxBodyLength = Infinity;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (config.insecureHTTPParser) {
|
||||||
|
options.insecureHTTPParser = config.insecureHTTPParser;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create the request
|
||||||
|
req = transport.request(options, function handleResponse(res) {
|
||||||
|
if (req.destroyed) return;
|
||||||
|
|
||||||
|
const streams = [res];
|
||||||
|
|
||||||
|
const responseLength = utils.toFiniteNumber(res.headers['content-length']);
|
||||||
|
|
||||||
|
if (onDownloadProgress || maxDownloadRate) {
|
||||||
|
const transformStream = new AxiosTransformStream({
|
||||||
|
maxRate: utils.toFiniteNumber(maxDownloadRate)
|
||||||
|
});
|
||||||
|
|
||||||
|
onDownloadProgress && transformStream.on('progress', flushOnFinish(
|
||||||
|
transformStream,
|
||||||
|
progressEventDecorator(
|
||||||
|
responseLength,
|
||||||
|
progressEventReducer(asyncDecorator(onDownloadProgress), true, 3)
|
||||||
|
)
|
||||||
|
));
|
||||||
|
|
||||||
|
streams.push(transformStream);
|
||||||
|
}
|
||||||
|
|
||||||
|
// decompress the response body transparently if required
|
||||||
|
let responseStream = res;
|
||||||
|
|
||||||
|
// return the last request in case of redirects
|
||||||
|
const lastRequest = res.req || req;
|
||||||
|
|
||||||
|
// if decompress disabled we should not decompress
|
||||||
|
if (config.decompress !== false && res.headers['content-encoding']) {
|
||||||
|
// if no content, but headers still say that it is encoded,
|
||||||
|
// remove the header not confuse downstream operations
|
||||||
|
if (method === 'HEAD' || res.statusCode === 204) {
|
||||||
|
delete res.headers['content-encoding'];
|
||||||
|
}
|
||||||
|
|
||||||
|
switch ((res.headers['content-encoding'] || '').toLowerCase()) {
|
||||||
|
/*eslint default-case:0*/
|
||||||
|
case 'gzip':
|
||||||
|
case 'x-gzip':
|
||||||
|
case 'compress':
|
||||||
|
case 'x-compress':
|
||||||
|
// add the unzipper to the body stream processing pipeline
|
||||||
|
streams.push(zlib.createUnzip(zlibOptions));
|
||||||
|
|
||||||
|
// remove the content-encoding in order to not confuse downstream operations
|
||||||
|
delete res.headers['content-encoding'];
|
||||||
|
break;
|
||||||
|
case 'deflate':
|
||||||
|
streams.push(new ZlibHeaderTransformStream());
|
||||||
|
|
||||||
|
// add the unzipper to the body stream processing pipeline
|
||||||
|
streams.push(zlib.createUnzip(zlibOptions));
|
||||||
|
|
||||||
|
// remove the content-encoding in order to not confuse downstream operations
|
||||||
|
delete res.headers['content-encoding'];
|
||||||
|
break;
|
||||||
|
case 'br':
|
||||||
|
if (isBrotliSupported) {
|
||||||
|
streams.push(zlib.createBrotliDecompress(brotliOptions));
|
||||||
|
delete res.headers['content-encoding'];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
responseStream = streams.length > 1 ? stream.pipeline(streams, utils.noop) : streams[0];
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
const response = {
|
||||||
|
status: res.statusCode,
|
||||||
|
statusText: res.statusMessage,
|
||||||
|
headers: new AxiosHeaders(res.headers),
|
||||||
|
config,
|
||||||
|
request: lastRequest
|
||||||
|
};
|
||||||
|
|
||||||
|
if (responseType === 'stream') {
|
||||||
|
response.data = responseStream;
|
||||||
|
settle(resolve, reject, response);
|
||||||
|
} else {
|
||||||
|
const responseBuffer = [];
|
||||||
|
let totalResponseBytes = 0;
|
||||||
|
|
||||||
|
responseStream.on('data', function handleStreamData(chunk) {
|
||||||
|
responseBuffer.push(chunk);
|
||||||
|
totalResponseBytes += chunk.length;
|
||||||
|
|
||||||
|
// make sure the content length is not over the maxContentLength if specified
|
||||||
|
if (config.maxContentLength > -1 && totalResponseBytes > config.maxContentLength) {
|
||||||
|
// stream.destroy() emit aborted event before calling reject() on Node.js v16
|
||||||
|
rejected = true;
|
||||||
|
responseStream.destroy();
|
||||||
|
abort(new AxiosError('maxContentLength size of ' + config.maxContentLength + ' exceeded',
|
||||||
|
AxiosError.ERR_BAD_RESPONSE, config, lastRequest));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
responseStream.on('aborted', function handlerStreamAborted() {
|
||||||
|
if (rejected) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const err = new AxiosError(
|
||||||
|
'stream has been aborted',
|
||||||
|
AxiosError.ERR_BAD_RESPONSE,
|
||||||
|
config,
|
||||||
|
lastRequest
|
||||||
|
);
|
||||||
|
responseStream.destroy(err);
|
||||||
|
reject(err);
|
||||||
|
});
|
||||||
|
|
||||||
|
responseStream.on('error', function handleStreamError(err) {
|
||||||
|
if (req.destroyed) return;
|
||||||
|
reject(AxiosError.from(err, null, config, lastRequest));
|
||||||
|
});
|
||||||
|
|
||||||
|
responseStream.on('end', function handleStreamEnd() {
|
||||||
|
try {
|
||||||
|
let responseData = responseBuffer.length === 1 ? responseBuffer[0] : Buffer.concat(responseBuffer);
|
||||||
|
if (responseType !== 'arraybuffer') {
|
||||||
|
responseData = responseData.toString(responseEncoding);
|
||||||
|
if (!responseEncoding || responseEncoding === 'utf8') {
|
||||||
|
responseData = utils.stripBOM(responseData);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
response.data = responseData;
|
||||||
|
} catch (err) {
|
||||||
|
return reject(AxiosError.from(err, null, config, response.request, response));
|
||||||
|
}
|
||||||
|
settle(resolve, reject, response);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
abortEmitter.once('abort', err => {
|
||||||
|
if (!responseStream.destroyed) {
|
||||||
|
responseStream.emit('error', err);
|
||||||
|
responseStream.destroy();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
abortEmitter.once('abort', err => {
|
||||||
|
if (req.close) {
|
||||||
|
req.close();
|
||||||
|
} else {
|
||||||
|
req.destroy(err);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle errors
|
||||||
|
req.on('error', function handleRequestError(err) {
|
||||||
|
// @todo remove
|
||||||
|
// if (req.aborted && err.code !== AxiosError.ERR_FR_TOO_MANY_REDIRECTS) return;
|
||||||
|
reject(AxiosError.from(err, null, config, req));
|
||||||
|
});
|
||||||
|
|
||||||
|
// set tcp keep alive to prevent drop connection by peer
|
||||||
|
req.on('socket', function handleRequestSocket(socket) {
|
||||||
|
// default interval of sending ack packet is 1 minute
|
||||||
|
socket.setKeepAlive(true, 1000 * 60);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Handle request timeout
|
||||||
|
if (config.timeout) {
|
||||||
|
// This is forcing a int timeout to avoid problems if the `req` interface doesn't handle other types.
|
||||||
|
const timeout = parseInt(config.timeout, 10);
|
||||||
|
|
||||||
|
if (Number.isNaN(timeout)) {
|
||||||
|
abort(new AxiosError(
|
||||||
|
'error trying to parse `config.timeout` to int',
|
||||||
|
AxiosError.ERR_BAD_OPTION_VALUE,
|
||||||
|
config,
|
||||||
|
req
|
||||||
|
));
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Sometime, the response will be very slow, and does not respond, the connect event will be block by event loop system.
|
||||||
|
// And timer callback will be fired, and abort() will be invoked before connection, then get "socket hang up" and code ECONNRESET.
|
||||||
|
// At this time, if we have a large number of request, nodejs will hang up some socket on background. and the number will up and up.
|
||||||
|
// And then these socket which be hang up will devouring CPU little by little.
|
||||||
|
// ClientRequest.setTimeout will be fired on the specify milliseconds, and can make sure that abort() will be fired after connect.
|
||||||
|
req.setTimeout(timeout, function handleRequestTimeout() {
|
||||||
|
if (isDone) return;
|
||||||
|
let timeoutErrorMessage = config.timeout ? 'timeout of ' + config.timeout + 'ms exceeded' : 'timeout exceeded';
|
||||||
|
const transitional = config.transitional || transitionalDefaults;
|
||||||
|
if (config.timeoutErrorMessage) {
|
||||||
|
timeoutErrorMessage = config.timeoutErrorMessage;
|
||||||
|
}
|
||||||
|
abort(new AxiosError(
|
||||||
|
timeoutErrorMessage,
|
||||||
|
transitional.clarifyTimeoutError ? AxiosError.ETIMEDOUT : AxiosError.ECONNABORTED,
|
||||||
|
config,
|
||||||
|
req
|
||||||
|
));
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
// explicitly reset the socket timeout value for a possible `keep-alive` request
|
||||||
|
req.setTimeout(0);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Send the request
|
||||||
|
if (utils.isStream(data)) {
|
||||||
|
let ended = false;
|
||||||
|
let errored = false;
|
||||||
|
|
||||||
|
data.on('end', () => {
|
||||||
|
ended = true;
|
||||||
|
});
|
||||||
|
|
||||||
|
data.once('error', err => {
|
||||||
|
errored = true;
|
||||||
|
req.destroy(err);
|
||||||
|
});
|
||||||
|
|
||||||
|
data.on('close', () => {
|
||||||
|
if (!ended && !errored) {
|
||||||
|
abort(new CanceledError('Request stream has been aborted', config, req));
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
data.pipe(req);
|
||||||
|
} else {
|
||||||
|
data && req.write(data);
|
||||||
|
req.end();
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
export const __setProxy = setProxy;
|
||||||
|
|
@ -0,0 +1,200 @@
|
||||||
|
import utils from './../utils.js';
|
||||||
|
import settle from './../core/settle.js';
|
||||||
|
import transitionalDefaults from '../defaults/transitional.js';
|
||||||
|
import AxiosError from '../core/AxiosError.js';
|
||||||
|
import CanceledError from '../cancel/CanceledError.js';
|
||||||
|
import parseProtocol from '../helpers/parseProtocol.js';
|
||||||
|
import platform from '../platform/index.js';
|
||||||
|
import AxiosHeaders from '../core/AxiosHeaders.js';
|
||||||
|
import {progressEventReducer} from '../helpers/progressEventReducer.js';
|
||||||
|
import resolveConfig from "../helpers/resolveConfig.js";
|
||||||
|
|
||||||
|
const isXHRAdapterSupported = typeof XMLHttpRequest !== 'undefined';
|
||||||
|
|
||||||
|
export default isXHRAdapterSupported && function (config) {
|
||||||
|
return new Promise(function dispatchXhrRequest(resolve, reject) {
|
||||||
|
const _config = resolveConfig(config);
|
||||||
|
let requestData = _config.data;
|
||||||
|
const requestHeaders = AxiosHeaders.from(_config.headers).normalize();
|
||||||
|
let {responseType, onUploadProgress, onDownloadProgress} = _config;
|
||||||
|
let onCanceled;
|
||||||
|
let uploadThrottled, downloadThrottled;
|
||||||
|
let flushUpload, flushDownload;
|
||||||
|
|
||||||
|
function done() {
|
||||||
|
flushUpload && flushUpload(); // flush events
|
||||||
|
flushDownload && flushDownload(); // flush events
|
||||||
|
|
||||||
|
_config.cancelToken && _config.cancelToken.unsubscribe(onCanceled);
|
||||||
|
|
||||||
|
_config.signal && _config.signal.removeEventListener('abort', onCanceled);
|
||||||
|
}
|
||||||
|
|
||||||
|
let request = new XMLHttpRequest();
|
||||||
|
|
||||||
|
request.open(_config.method.toUpperCase(), _config.url, true);
|
||||||
|
|
||||||
|
// Set the request timeout in MS
|
||||||
|
request.timeout = _config.timeout;
|
||||||
|
|
||||||
|
function onloadend() {
|
||||||
|
if (!request) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// Prepare the response
|
||||||
|
const responseHeaders = AxiosHeaders.from(
|
||||||
|
'getAllResponseHeaders' in request && request.getAllResponseHeaders()
|
||||||
|
);
|
||||||
|
const responseData = !responseType || responseType === 'text' || responseType === 'json' ?
|
||||||
|
request.responseText : request.response;
|
||||||
|
const response = {
|
||||||
|
data: responseData,
|
||||||
|
status: request.status,
|
||||||
|
statusText: request.statusText,
|
||||||
|
headers: responseHeaders,
|
||||||
|
config,
|
||||||
|
request
|
||||||
|
};
|
||||||
|
|
||||||
|
settle(function _resolve(value) {
|
||||||
|
resolve(value);
|
||||||
|
done();
|
||||||
|
}, function _reject(err) {
|
||||||
|
reject(err);
|
||||||
|
done();
|
||||||
|
}, response);
|
||||||
|
|
||||||
|
// Clean up request
|
||||||
|
request = null;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ('onloadend' in request) {
|
||||||
|
// Use onloadend if available
|
||||||
|
request.onloadend = onloadend;
|
||||||
|
} else {
|
||||||
|
// Listen for ready state to emulate onloadend
|
||||||
|
request.onreadystatechange = function handleLoad() {
|
||||||
|
if (!request || request.readyState !== 4) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// The request errored out and we didn't get a response, this will be
|
||||||
|
// handled by onerror instead
|
||||||
|
// With one exception: request that using file: protocol, most browsers
|
||||||
|
// will return status as 0 even though it's a successful request
|
||||||
|
if (request.status === 0 && !(request.responseURL && request.responseURL.indexOf('file:') === 0)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
// readystate handler is calling before onerror or ontimeout handlers,
|
||||||
|
// so we should call onloadend on the next 'tick'
|
||||||
|
setTimeout(onloadend);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle browser request cancellation (as opposed to a manual cancellation)
|
||||||
|
request.onabort = function handleAbort() {
|
||||||
|
if (!request) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
reject(new AxiosError('Request aborted', AxiosError.ECONNABORTED, config, request));
|
||||||
|
|
||||||
|
// Clean up request
|
||||||
|
request = null;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Handle low level network errors
|
||||||
|
request.onerror = function handleError(event) {
|
||||||
|
// Browsers deliver a ProgressEvent in XHR onerror
|
||||||
|
// (message may be empty; when present, surface it)
|
||||||
|
// See https://developer.mozilla.org/docs/Web/API/XMLHttpRequest/error_event
|
||||||
|
const msg = event && event.message ? event.message : 'Network Error';
|
||||||
|
const err = new AxiosError(msg, AxiosError.ERR_NETWORK, config, request);
|
||||||
|
// attach the underlying event for consumers who want details
|
||||||
|
err.event = event || null;
|
||||||
|
reject(err);
|
||||||
|
request = null;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Handle timeout
|
||||||
|
request.ontimeout = function handleTimeout() {
|
||||||
|
let timeoutErrorMessage = _config.timeout ? 'timeout of ' + _config.timeout + 'ms exceeded' : 'timeout exceeded';
|
||||||
|
const transitional = _config.transitional || transitionalDefaults;
|
||||||
|
if (_config.timeoutErrorMessage) {
|
||||||
|
timeoutErrorMessage = _config.timeoutErrorMessage;
|
||||||
|
}
|
||||||
|
reject(new AxiosError(
|
||||||
|
timeoutErrorMessage,
|
||||||
|
transitional.clarifyTimeoutError ? AxiosError.ETIMEDOUT : AxiosError.ECONNABORTED,
|
||||||
|
config,
|
||||||
|
request));
|
||||||
|
|
||||||
|
// Clean up request
|
||||||
|
request = null;
|
||||||
|
};
|
||||||
|
|
||||||
|
// Remove Content-Type if data is undefined
|
||||||
|
requestData === undefined && requestHeaders.setContentType(null);
|
||||||
|
|
||||||
|
// Add headers to the request
|
||||||
|
if ('setRequestHeader' in request) {
|
||||||
|
utils.forEach(requestHeaders.toJSON(), function setRequestHeader(val, key) {
|
||||||
|
request.setRequestHeader(key, val);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add withCredentials to request if needed
|
||||||
|
if (!utils.isUndefined(_config.withCredentials)) {
|
||||||
|
request.withCredentials = !!_config.withCredentials;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Add responseType to request if needed
|
||||||
|
if (responseType && responseType !== 'json') {
|
||||||
|
request.responseType = _config.responseType;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle progress if needed
|
||||||
|
if (onDownloadProgress) {
|
||||||
|
([downloadThrottled, flushDownload] = progressEventReducer(onDownloadProgress, true));
|
||||||
|
request.addEventListener('progress', downloadThrottled);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Not all browsers support upload events
|
||||||
|
if (onUploadProgress && request.upload) {
|
||||||
|
([uploadThrottled, flushUpload] = progressEventReducer(onUploadProgress));
|
||||||
|
|
||||||
|
request.upload.addEventListener('progress', uploadThrottled);
|
||||||
|
|
||||||
|
request.upload.addEventListener('loadend', flushUpload);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (_config.cancelToken || _config.signal) {
|
||||||
|
// Handle cancellation
|
||||||
|
// eslint-disable-next-line func-names
|
||||||
|
onCanceled = cancel => {
|
||||||
|
if (!request) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
reject(!cancel || cancel.type ? new CanceledError(null, config, request) : cancel);
|
||||||
|
request.abort();
|
||||||
|
request = null;
|
||||||
|
};
|
||||||
|
|
||||||
|
_config.cancelToken && _config.cancelToken.subscribe(onCanceled);
|
||||||
|
if (_config.signal) {
|
||||||
|
_config.signal.aborted ? onCanceled() : _config.signal.addEventListener('abort', onCanceled);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const protocol = parseProtocol(_config.url);
|
||||||
|
|
||||||
|
if (protocol && platform.protocols.indexOf(protocol) === -1) {
|
||||||
|
reject(new AxiosError('Unsupported protocol ' + protocol + ':', AxiosError.ERR_BAD_REQUEST, config));
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
// Send the request
|
||||||
|
request.send(requestData || null);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,89 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
import utils from './utils.js';
|
||||||
|
import bind from './helpers/bind.js';
|
||||||
|
import Axios from './core/Axios.js';
|
||||||
|
import mergeConfig from './core/mergeConfig.js';
|
||||||
|
import defaults from './defaults/index.js';
|
||||||
|
import formDataToJSON from './helpers/formDataToJSON.js';
|
||||||
|
import CanceledError from './cancel/CanceledError.js';
|
||||||
|
import CancelToken from './cancel/CancelToken.js';
|
||||||
|
import isCancel from './cancel/isCancel.js';
|
||||||
|
import {VERSION} from './env/data.js';
|
||||||
|
import toFormData from './helpers/toFormData.js';
|
||||||
|
import AxiosError from './core/AxiosError.js';
|
||||||
|
import spread from './helpers/spread.js';
|
||||||
|
import isAxiosError from './helpers/isAxiosError.js';
|
||||||
|
import AxiosHeaders from "./core/AxiosHeaders.js";
|
||||||
|
import adapters from './adapters/adapters.js';
|
||||||
|
import HttpStatusCode from './helpers/HttpStatusCode.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create an instance of Axios
|
||||||
|
*
|
||||||
|
* @param {Object} defaultConfig The default config for the instance
|
||||||
|
*
|
||||||
|
* @returns {Axios} A new instance of Axios
|
||||||
|
*/
|
||||||
|
function createInstance(defaultConfig) {
|
||||||
|
const context = new Axios(defaultConfig);
|
||||||
|
const instance = bind(Axios.prototype.request, context);
|
||||||
|
|
||||||
|
// Copy axios.prototype to instance
|
||||||
|
utils.extend(instance, Axios.prototype, context, {allOwnKeys: true});
|
||||||
|
|
||||||
|
// Copy context to instance
|
||||||
|
utils.extend(instance, context, null, {allOwnKeys: true});
|
||||||
|
|
||||||
|
// Factory for creating new instances
|
||||||
|
instance.create = function create(instanceConfig) {
|
||||||
|
return createInstance(mergeConfig(defaultConfig, instanceConfig));
|
||||||
|
};
|
||||||
|
|
||||||
|
return instance;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Create the default instance to be exported
|
||||||
|
const axios = createInstance(defaults);
|
||||||
|
|
||||||
|
// Expose Axios class to allow class inheritance
|
||||||
|
axios.Axios = Axios;
|
||||||
|
|
||||||
|
// Expose Cancel & CancelToken
|
||||||
|
axios.CanceledError = CanceledError;
|
||||||
|
axios.CancelToken = CancelToken;
|
||||||
|
axios.isCancel = isCancel;
|
||||||
|
axios.VERSION = VERSION;
|
||||||
|
axios.toFormData = toFormData;
|
||||||
|
|
||||||
|
// Expose AxiosError class
|
||||||
|
axios.AxiosError = AxiosError;
|
||||||
|
|
||||||
|
// alias for CanceledError for backward compatibility
|
||||||
|
axios.Cancel = axios.CanceledError;
|
||||||
|
|
||||||
|
// Expose all/spread
|
||||||
|
axios.all = function all(promises) {
|
||||||
|
return Promise.all(promises);
|
||||||
|
};
|
||||||
|
|
||||||
|
axios.spread = spread;
|
||||||
|
|
||||||
|
// Expose isAxiosError
|
||||||
|
axios.isAxiosError = isAxiosError;
|
||||||
|
|
||||||
|
// Expose mergeConfig
|
||||||
|
axios.mergeConfig = mergeConfig;
|
||||||
|
|
||||||
|
axios.AxiosHeaders = AxiosHeaders;
|
||||||
|
|
||||||
|
axios.formToJSON = thing => formDataToJSON(utils.isHTMLForm(thing) ? new FormData(thing) : thing);
|
||||||
|
|
||||||
|
axios.getAdapter = adapters.getAdapter;
|
||||||
|
|
||||||
|
axios.HttpStatusCode = HttpStatusCode;
|
||||||
|
|
||||||
|
axios.default = axios;
|
||||||
|
|
||||||
|
// this module should only have a default export
|
||||||
|
export default axios
|
||||||
|
|
@ -0,0 +1,135 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
import CanceledError from './CanceledError.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A `CancelToken` is an object that can be used to request cancellation of an operation.
|
||||||
|
*
|
||||||
|
* @param {Function} executor The executor function.
|
||||||
|
*
|
||||||
|
* @returns {CancelToken}
|
||||||
|
*/
|
||||||
|
class CancelToken {
|
||||||
|
constructor(executor) {
|
||||||
|
if (typeof executor !== 'function') {
|
||||||
|
throw new TypeError('executor must be a function.');
|
||||||
|
}
|
||||||
|
|
||||||
|
let resolvePromise;
|
||||||
|
|
||||||
|
this.promise = new Promise(function promiseExecutor(resolve) {
|
||||||
|
resolvePromise = resolve;
|
||||||
|
});
|
||||||
|
|
||||||
|
const token = this;
|
||||||
|
|
||||||
|
// eslint-disable-next-line func-names
|
||||||
|
this.promise.then(cancel => {
|
||||||
|
if (!token._listeners) return;
|
||||||
|
|
||||||
|
let i = token._listeners.length;
|
||||||
|
|
||||||
|
while (i-- > 0) {
|
||||||
|
token._listeners[i](cancel);
|
||||||
|
}
|
||||||
|
token._listeners = null;
|
||||||
|
});
|
||||||
|
|
||||||
|
// eslint-disable-next-line func-names
|
||||||
|
this.promise.then = onfulfilled => {
|
||||||
|
let _resolve;
|
||||||
|
// eslint-disable-next-line func-names
|
||||||
|
const promise = new Promise(resolve => {
|
||||||
|
token.subscribe(resolve);
|
||||||
|
_resolve = resolve;
|
||||||
|
}).then(onfulfilled);
|
||||||
|
|
||||||
|
promise.cancel = function reject() {
|
||||||
|
token.unsubscribe(_resolve);
|
||||||
|
};
|
||||||
|
|
||||||
|
return promise;
|
||||||
|
};
|
||||||
|
|
||||||
|
executor(function cancel(message, config, request) {
|
||||||
|
if (token.reason) {
|
||||||
|
// Cancellation has already been requested
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
token.reason = new CanceledError(message, config, request);
|
||||||
|
resolvePromise(token.reason);
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Throws a `CanceledError` if cancellation has been requested.
|
||||||
|
*/
|
||||||
|
throwIfRequested() {
|
||||||
|
if (this.reason) {
|
||||||
|
throw this.reason;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Subscribe to the cancel signal
|
||||||
|
*/
|
||||||
|
|
||||||
|
subscribe(listener) {
|
||||||
|
if (this.reason) {
|
||||||
|
listener(this.reason);
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this._listeners) {
|
||||||
|
this._listeners.push(listener);
|
||||||
|
} else {
|
||||||
|
this._listeners = [listener];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Unsubscribe from the cancel signal
|
||||||
|
*/
|
||||||
|
|
||||||
|
unsubscribe(listener) {
|
||||||
|
if (!this._listeners) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
const index = this._listeners.indexOf(listener);
|
||||||
|
if (index !== -1) {
|
||||||
|
this._listeners.splice(index, 1);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
toAbortSignal() {
|
||||||
|
const controller = new AbortController();
|
||||||
|
|
||||||
|
const abort = (err) => {
|
||||||
|
controller.abort(err);
|
||||||
|
};
|
||||||
|
|
||||||
|
this.subscribe(abort);
|
||||||
|
|
||||||
|
controller.signal.unsubscribe = () => this.unsubscribe(abort);
|
||||||
|
|
||||||
|
return controller.signal;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an object that contains a new `CancelToken` and a function that, when called,
|
||||||
|
* cancels the `CancelToken`.
|
||||||
|
*/
|
||||||
|
static source() {
|
||||||
|
let cancel;
|
||||||
|
const token = new CancelToken(function executor(c) {
|
||||||
|
cancel = c;
|
||||||
|
});
|
||||||
|
return {
|
||||||
|
token,
|
||||||
|
cancel
|
||||||
|
};
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default CancelToken;
|
||||||
|
|
@ -0,0 +1,25 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
import AxiosError from '../core/AxiosError.js';
|
||||||
|
import utils from '../utils.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A `CanceledError` is an object that is thrown when an operation is canceled.
|
||||||
|
*
|
||||||
|
* @param {string=} message The message.
|
||||||
|
* @param {Object=} config The config.
|
||||||
|
* @param {Object=} request The request.
|
||||||
|
*
|
||||||
|
* @returns {CanceledError} The created error.
|
||||||
|
*/
|
||||||
|
function CanceledError(message, config, request) {
|
||||||
|
// eslint-disable-next-line no-eq-null,eqeqeq
|
||||||
|
AxiosError.call(this, message == null ? 'canceled' : message, AxiosError.ERR_CANCELED, config, request);
|
||||||
|
this.name = 'CanceledError';
|
||||||
|
}
|
||||||
|
|
||||||
|
utils.inherits(CanceledError, AxiosError, {
|
||||||
|
__CANCEL__: true
|
||||||
|
});
|
||||||
|
|
||||||
|
export default CanceledError;
|
||||||
|
|
@ -0,0 +1,5 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
export default function isCancel(value) {
|
||||||
|
return !!(value && value.__CANCEL__);
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,240 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
import utils from './../utils.js';
|
||||||
|
import buildURL from '../helpers/buildURL.js';
|
||||||
|
import InterceptorManager from './InterceptorManager.js';
|
||||||
|
import dispatchRequest from './dispatchRequest.js';
|
||||||
|
import mergeConfig from './mergeConfig.js';
|
||||||
|
import buildFullPath from './buildFullPath.js';
|
||||||
|
import validator from '../helpers/validator.js';
|
||||||
|
import AxiosHeaders from './AxiosHeaders.js';
|
||||||
|
|
||||||
|
const validators = validator.validators;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create a new instance of Axios
|
||||||
|
*
|
||||||
|
* @param {Object} instanceConfig The default config for the instance
|
||||||
|
*
|
||||||
|
* @return {Axios} A new instance of Axios
|
||||||
|
*/
|
||||||
|
class Axios {
|
||||||
|
constructor(instanceConfig) {
|
||||||
|
this.defaults = instanceConfig || {};
|
||||||
|
this.interceptors = {
|
||||||
|
request: new InterceptorManager(),
|
||||||
|
response: new InterceptorManager()
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Dispatch a request
|
||||||
|
*
|
||||||
|
* @param {String|Object} configOrUrl The config specific for this request (merged with this.defaults)
|
||||||
|
* @param {?Object} config
|
||||||
|
*
|
||||||
|
* @returns {Promise} The Promise to be fulfilled
|
||||||
|
*/
|
||||||
|
async request(configOrUrl, config) {
|
||||||
|
try {
|
||||||
|
return await this._request(configOrUrl, config);
|
||||||
|
} catch (err) {
|
||||||
|
if (err instanceof Error) {
|
||||||
|
let dummy = {};
|
||||||
|
|
||||||
|
Error.captureStackTrace ? Error.captureStackTrace(dummy) : (dummy = new Error());
|
||||||
|
|
||||||
|
// slice off the Error: ... line
|
||||||
|
const stack = dummy.stack ? dummy.stack.replace(/^.+\n/, '') : '';
|
||||||
|
try {
|
||||||
|
if (!err.stack) {
|
||||||
|
err.stack = stack;
|
||||||
|
// match without the 2 top stack lines
|
||||||
|
} else if (stack && !String(err.stack).endsWith(stack.replace(/^.+\n.+\n/, ''))) {
|
||||||
|
err.stack += '\n' + stack
|
||||||
|
}
|
||||||
|
} catch (e) {
|
||||||
|
// ignore the case where "stack" is an un-writable property
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
throw err;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
_request(configOrUrl, config) {
|
||||||
|
/*eslint no-param-reassign:0*/
|
||||||
|
// Allow for axios('example/url'[, config]) a la fetch API
|
||||||
|
if (typeof configOrUrl === 'string') {
|
||||||
|
config = config || {};
|
||||||
|
config.url = configOrUrl;
|
||||||
|
} else {
|
||||||
|
config = configOrUrl || {};
|
||||||
|
}
|
||||||
|
|
||||||
|
config = mergeConfig(this.defaults, config);
|
||||||
|
|
||||||
|
const {transitional, paramsSerializer, headers} = config;
|
||||||
|
|
||||||
|
if (transitional !== undefined) {
|
||||||
|
validator.assertOptions(transitional, {
|
||||||
|
silentJSONParsing: validators.transitional(validators.boolean),
|
||||||
|
forcedJSONParsing: validators.transitional(validators.boolean),
|
||||||
|
clarifyTimeoutError: validators.transitional(validators.boolean)
|
||||||
|
}, false);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (paramsSerializer != null) {
|
||||||
|
if (utils.isFunction(paramsSerializer)) {
|
||||||
|
config.paramsSerializer = {
|
||||||
|
serialize: paramsSerializer
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
validator.assertOptions(paramsSerializer, {
|
||||||
|
encode: validators.function,
|
||||||
|
serialize: validators.function
|
||||||
|
}, true);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Set config.allowAbsoluteUrls
|
||||||
|
if (config.allowAbsoluteUrls !== undefined) {
|
||||||
|
// do nothing
|
||||||
|
} else if (this.defaults.allowAbsoluteUrls !== undefined) {
|
||||||
|
config.allowAbsoluteUrls = this.defaults.allowAbsoluteUrls;
|
||||||
|
} else {
|
||||||
|
config.allowAbsoluteUrls = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
validator.assertOptions(config, {
|
||||||
|
baseUrl: validators.spelling('baseURL'),
|
||||||
|
withXsrfToken: validators.spelling('withXSRFToken')
|
||||||
|
}, true);
|
||||||
|
|
||||||
|
// Set config.method
|
||||||
|
config.method = (config.method || this.defaults.method || 'get').toLowerCase();
|
||||||
|
|
||||||
|
// Flatten headers
|
||||||
|
let contextHeaders = headers && utils.merge(
|
||||||
|
headers.common,
|
||||||
|
headers[config.method]
|
||||||
|
);
|
||||||
|
|
||||||
|
headers && utils.forEach(
|
||||||
|
['delete', 'get', 'head', 'post', 'put', 'patch', 'common'],
|
||||||
|
(method) => {
|
||||||
|
delete headers[method];
|
||||||
|
}
|
||||||
|
);
|
||||||
|
|
||||||
|
config.headers = AxiosHeaders.concat(contextHeaders, headers);
|
||||||
|
|
||||||
|
// filter out skipped interceptors
|
||||||
|
const requestInterceptorChain = [];
|
||||||
|
let synchronousRequestInterceptors = true;
|
||||||
|
this.interceptors.request.forEach(function unshiftRequestInterceptors(interceptor) {
|
||||||
|
if (typeof interceptor.runWhen === 'function' && interceptor.runWhen(config) === false) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
synchronousRequestInterceptors = synchronousRequestInterceptors && interceptor.synchronous;
|
||||||
|
|
||||||
|
requestInterceptorChain.unshift(interceptor.fulfilled, interceptor.rejected);
|
||||||
|
});
|
||||||
|
|
||||||
|
const responseInterceptorChain = [];
|
||||||
|
this.interceptors.response.forEach(function pushResponseInterceptors(interceptor) {
|
||||||
|
responseInterceptorChain.push(interceptor.fulfilled, interceptor.rejected);
|
||||||
|
});
|
||||||
|
|
||||||
|
let promise;
|
||||||
|
let i = 0;
|
||||||
|
let len;
|
||||||
|
|
||||||
|
if (!synchronousRequestInterceptors) {
|
||||||
|
const chain = [dispatchRequest.bind(this), undefined];
|
||||||
|
chain.unshift(...requestInterceptorChain);
|
||||||
|
chain.push(...responseInterceptorChain);
|
||||||
|
len = chain.length;
|
||||||
|
|
||||||
|
promise = Promise.resolve(config);
|
||||||
|
|
||||||
|
while (i < len) {
|
||||||
|
promise = promise.then(chain[i++], chain[i++]);
|
||||||
|
}
|
||||||
|
|
||||||
|
return promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
len = requestInterceptorChain.length;
|
||||||
|
|
||||||
|
let newConfig = config;
|
||||||
|
|
||||||
|
while (i < len) {
|
||||||
|
const onFulfilled = requestInterceptorChain[i++];
|
||||||
|
const onRejected = requestInterceptorChain[i++];
|
||||||
|
try {
|
||||||
|
newConfig = onFulfilled(newConfig);
|
||||||
|
} catch (error) {
|
||||||
|
onRejected.call(this, error);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
promise = dispatchRequest.call(this, newConfig);
|
||||||
|
} catch (error) {
|
||||||
|
return Promise.reject(error);
|
||||||
|
}
|
||||||
|
|
||||||
|
i = 0;
|
||||||
|
len = responseInterceptorChain.length;
|
||||||
|
|
||||||
|
while (i < len) {
|
||||||
|
promise = promise.then(responseInterceptorChain[i++], responseInterceptorChain[i++]);
|
||||||
|
}
|
||||||
|
|
||||||
|
return promise;
|
||||||
|
}
|
||||||
|
|
||||||
|
getUri(config) {
|
||||||
|
config = mergeConfig(this.defaults, config);
|
||||||
|
const fullPath = buildFullPath(config.baseURL, config.url, config.allowAbsoluteUrls);
|
||||||
|
return buildURL(fullPath, config.params, config.paramsSerializer);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Provide aliases for supported request methods
|
||||||
|
utils.forEach(['delete', 'get', 'head', 'options'], function forEachMethodNoData(method) {
|
||||||
|
/*eslint func-names:0*/
|
||||||
|
Axios.prototype[method] = function(url, config) {
|
||||||
|
return this.request(mergeConfig(config || {}, {
|
||||||
|
method,
|
||||||
|
url,
|
||||||
|
data: (config || {}).data
|
||||||
|
}));
|
||||||
|
};
|
||||||
|
});
|
||||||
|
|
||||||
|
utils.forEach(['post', 'put', 'patch'], function forEachMethodWithData(method) {
|
||||||
|
/*eslint func-names:0*/
|
||||||
|
|
||||||
|
function generateHTTPMethod(isForm) {
|
||||||
|
return function httpMethod(url, data, config) {
|
||||||
|
return this.request(mergeConfig(config || {}, {
|
||||||
|
method,
|
||||||
|
headers: isForm ? {
|
||||||
|
'Content-Type': 'multipart/form-data'
|
||||||
|
} : {},
|
||||||
|
url,
|
||||||
|
data
|
||||||
|
}));
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
Axios.prototype[method] = generateHTTPMethod();
|
||||||
|
|
||||||
|
Axios.prototype[method + 'Form'] = generateHTTPMethod(true);
|
||||||
|
});
|
||||||
|
|
||||||
|
export default Axios;
|
||||||
|
|
@ -0,0 +1,110 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
import utils from '../utils.js';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Create an Error with the specified message, config, error code, request and response.
|
||||||
|
*
|
||||||
|
* @param {string} message The error message.
|
||||||
|
* @param {string} [code] The error code (for example, 'ECONNABORTED').
|
||||||
|
* @param {Object} [config] The config.
|
||||||
|
* @param {Object} [request] The request.
|
||||||
|
* @param {Object} [response] The response.
|
||||||
|
*
|
||||||
|
* @returns {Error} The created error.
|
||||||
|
*/
|
||||||
|
function AxiosError(message, code, config, request, response) {
|
||||||
|
Error.call(this);
|
||||||
|
|
||||||
|
if (Error.captureStackTrace) {
|
||||||
|
Error.captureStackTrace(this, this.constructor);
|
||||||
|
} else {
|
||||||
|
this.stack = (new Error()).stack;
|
||||||
|
}
|
||||||
|
|
||||||
|
this.message = message;
|
||||||
|
this.name = 'AxiosError';
|
||||||
|
code && (this.code = code);
|
||||||
|
config && (this.config = config);
|
||||||
|
request && (this.request = request);
|
||||||
|
if (response) {
|
||||||
|
this.response = response;
|
||||||
|
this.status = response.status ? response.status : null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
utils.inherits(AxiosError, Error, {
|
||||||
|
toJSON: function toJSON() {
|
||||||
|
return {
|
||||||
|
// Standard
|
||||||
|
message: this.message,
|
||||||
|
name: this.name,
|
||||||
|
// Microsoft
|
||||||
|
description: this.description,
|
||||||
|
number: this.number,
|
||||||
|
// Mozilla
|
||||||
|
fileName: this.fileName,
|
||||||
|
lineNumber: this.lineNumber,
|
||||||
|
columnNumber: this.columnNumber,
|
||||||
|
stack: this.stack,
|
||||||
|
// Axios
|
||||||
|
config: utils.toJSONObject(this.config),
|
||||||
|
code: this.code,
|
||||||
|
status: this.status
|
||||||
|
};
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
const prototype = AxiosError.prototype;
|
||||||
|
const descriptors = {};
|
||||||
|
|
||||||
|
[
|
||||||
|
'ERR_BAD_OPTION_VALUE',
|
||||||
|
'ERR_BAD_OPTION',
|
||||||
|
'ECONNABORTED',
|
||||||
|
'ETIMEDOUT',
|
||||||
|
'ERR_NETWORK',
|
||||||
|
'ERR_FR_TOO_MANY_REDIRECTS',
|
||||||
|
'ERR_DEPRECATED',
|
||||||
|
'ERR_BAD_RESPONSE',
|
||||||
|
'ERR_BAD_REQUEST',
|
||||||
|
'ERR_CANCELED',
|
||||||
|
'ERR_NOT_SUPPORT',
|
||||||
|
'ERR_INVALID_URL'
|
||||||
|
// eslint-disable-next-line func-names
|
||||||
|
].forEach(code => {
|
||||||
|
descriptors[code] = {value: code};
|
||||||
|
});
|
||||||
|
|
||||||
|
Object.defineProperties(AxiosError, descriptors);
|
||||||
|
Object.defineProperty(prototype, 'isAxiosError', {value: true});
|
||||||
|
|
||||||
|
// eslint-disable-next-line func-names
|
||||||
|
AxiosError.from = (error, code, config, request, response, customProps) => {
|
||||||
|
const axiosError = Object.create(prototype);
|
||||||
|
|
||||||
|
utils.toFlatObject(error, axiosError, function filter(obj) {
|
||||||
|
return obj !== Error.prototype;
|
||||||
|
}, prop => {
|
||||||
|
return prop !== 'isAxiosError';
|
||||||
|
});
|
||||||
|
|
||||||
|
const msg = error && error.message ? error.message : 'Error';
|
||||||
|
|
||||||
|
// Prefer explicit code; otherwise copy the low-level error's code (e.g. ECONNREFUSED)
|
||||||
|
const errCode = code == null && error ? error.code : code;
|
||||||
|
AxiosError.call(axiosError, msg, errCode, config, request, response);
|
||||||
|
|
||||||
|
// Chain the original error on the standard field; non-enumerable to avoid JSON noise
|
||||||
|
if (error && axiosError.cause == null) {
|
||||||
|
Object.defineProperty(axiosError, 'cause', { value: error, configurable: true });
|
||||||
|
}
|
||||||
|
|
||||||
|
axiosError.name = (error && error.name) || 'Error';
|
||||||
|
|
||||||
|
customProps && Object.assign(axiosError, customProps);
|
||||||
|
|
||||||
|
return axiosError;
|
||||||
|
};
|
||||||
|
|
||||||
|
export default AxiosError;
|
||||||
|
|
@ -0,0 +1,314 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
import utils from '../utils.js';
|
||||||
|
import parseHeaders from '../helpers/parseHeaders.js';
|
||||||
|
|
||||||
|
const $internals = Symbol('internals');
|
||||||
|
|
||||||
|
function normalizeHeader(header) {
|
||||||
|
return header && String(header).trim().toLowerCase();
|
||||||
|
}
|
||||||
|
|
||||||
|
function normalizeValue(value) {
|
||||||
|
if (value === false || value == null) {
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
|
||||||
|
return utils.isArray(value) ? value.map(normalizeValue) : String(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function parseTokens(str) {
|
||||||
|
const tokens = Object.create(null);
|
||||||
|
const tokensRE = /([^\s,;=]+)\s*(?:=\s*([^,;]+))?/g;
|
||||||
|
let match;
|
||||||
|
|
||||||
|
while ((match = tokensRE.exec(str))) {
|
||||||
|
tokens[match[1]] = match[2];
|
||||||
|
}
|
||||||
|
|
||||||
|
return tokens;
|
||||||
|
}
|
||||||
|
|
||||||
|
const isValidHeaderName = (str) => /^[-_a-zA-Z0-9^`|~,!#$%&'*+.]+$/.test(str.trim());
|
||||||
|
|
||||||
|
function matchHeaderValue(context, value, header, filter, isHeaderNameFilter) {
|
||||||
|
if (utils.isFunction(filter)) {
|
||||||
|
return filter.call(this, value, header);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isHeaderNameFilter) {
|
||||||
|
value = header;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!utils.isString(value)) return;
|
||||||
|
|
||||||
|
if (utils.isString(filter)) {
|
||||||
|
return value.indexOf(filter) !== -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isRegExp(filter)) {
|
||||||
|
return filter.test(value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function formatHeader(header) {
|
||||||
|
return header.trim()
|
||||||
|
.toLowerCase().replace(/([a-z\d])(\w*)/g, (w, char, str) => {
|
||||||
|
return char.toUpperCase() + str;
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
function buildAccessors(obj, header) {
|
||||||
|
const accessorName = utils.toCamelCase(' ' + header);
|
||||||
|
|
||||||
|
['get', 'set', 'has'].forEach(methodName => {
|
||||||
|
Object.defineProperty(obj, methodName + accessorName, {
|
||||||
|
value: function(arg1, arg2, arg3) {
|
||||||
|
return this[methodName].call(this, header, arg1, arg2, arg3);
|
||||||
|
},
|
||||||
|
configurable: true
|
||||||
|
});
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
class AxiosHeaders {
|
||||||
|
constructor(headers) {
|
||||||
|
headers && this.set(headers);
|
||||||
|
}
|
||||||
|
|
||||||
|
set(header, valueOrRewrite, rewrite) {
|
||||||
|
const self = this;
|
||||||
|
|
||||||
|
function setHeader(_value, _header, _rewrite) {
|
||||||
|
const lHeader = normalizeHeader(_header);
|
||||||
|
|
||||||
|
if (!lHeader) {
|
||||||
|
throw new Error('header name must be a non-empty string');
|
||||||
|
}
|
||||||
|
|
||||||
|
const key = utils.findKey(self, lHeader);
|
||||||
|
|
||||||
|
if(!key || self[key] === undefined || _rewrite === true || (_rewrite === undefined && self[key] !== false)) {
|
||||||
|
self[key || _header] = normalizeValue(_value);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const setHeaders = (headers, _rewrite) =>
|
||||||
|
utils.forEach(headers, (_value, _header) => setHeader(_value, _header, _rewrite));
|
||||||
|
|
||||||
|
if (utils.isPlainObject(header) || header instanceof this.constructor) {
|
||||||
|
setHeaders(header, valueOrRewrite)
|
||||||
|
} else if(utils.isString(header) && (header = header.trim()) && !isValidHeaderName(header)) {
|
||||||
|
setHeaders(parseHeaders(header), valueOrRewrite);
|
||||||
|
} else if (utils.isObject(header) && utils.isIterable(header)) {
|
||||||
|
let obj = {}, dest, key;
|
||||||
|
for (const entry of header) {
|
||||||
|
if (!utils.isArray(entry)) {
|
||||||
|
throw TypeError('Object iterator must return a key-value pair');
|
||||||
|
}
|
||||||
|
|
||||||
|
obj[key = entry[0]] = (dest = obj[key]) ?
|
||||||
|
(utils.isArray(dest) ? [...dest, entry[1]] : [dest, entry[1]]) : entry[1];
|
||||||
|
}
|
||||||
|
|
||||||
|
setHeaders(obj, valueOrRewrite)
|
||||||
|
} else {
|
||||||
|
header != null && setHeader(valueOrRewrite, header, rewrite);
|
||||||
|
}
|
||||||
|
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
get(header, parser) {
|
||||||
|
header = normalizeHeader(header);
|
||||||
|
|
||||||
|
if (header) {
|
||||||
|
const key = utils.findKey(this, header);
|
||||||
|
|
||||||
|
if (key) {
|
||||||
|
const value = this[key];
|
||||||
|
|
||||||
|
if (!parser) {
|
||||||
|
return value;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (parser === true) {
|
||||||
|
return parseTokens(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isFunction(parser)) {
|
||||||
|
return parser.call(this, value, key);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isRegExp(parser)) {
|
||||||
|
return parser.exec(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
throw new TypeError('parser must be boolean|regexp|function');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
has(header, matcher) {
|
||||||
|
header = normalizeHeader(header);
|
||||||
|
|
||||||
|
if (header) {
|
||||||
|
const key = utils.findKey(this, header);
|
||||||
|
|
||||||
|
return !!(key && this[key] !== undefined && (!matcher || matchHeaderValue(this, this[key], key, matcher)));
|
||||||
|
}
|
||||||
|
|
||||||
|
return false;
|
||||||
|
}
|
||||||
|
|
||||||
|
delete(header, matcher) {
|
||||||
|
const self = this;
|
||||||
|
let deleted = false;
|
||||||
|
|
||||||
|
function deleteHeader(_header) {
|
||||||
|
_header = normalizeHeader(_header);
|
||||||
|
|
||||||
|
if (_header) {
|
||||||
|
const key = utils.findKey(self, _header);
|
||||||
|
|
||||||
|
if (key && (!matcher || matchHeaderValue(self, self[key], key, matcher))) {
|
||||||
|
delete self[key];
|
||||||
|
|
||||||
|
deleted = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (utils.isArray(header)) {
|
||||||
|
header.forEach(deleteHeader);
|
||||||
|
} else {
|
||||||
|
deleteHeader(header);
|
||||||
|
}
|
||||||
|
|
||||||
|
return deleted;
|
||||||
|
}
|
||||||
|
|
||||||
|
clear(matcher) {
|
||||||
|
const keys = Object.keys(this);
|
||||||
|
let i = keys.length;
|
||||||
|
let deleted = false;
|
||||||
|
|
||||||
|
while (i--) {
|
||||||
|
const key = keys[i];
|
||||||
|
if(!matcher || matchHeaderValue(this, this[key], key, matcher, true)) {
|
||||||
|
delete this[key];
|
||||||
|
deleted = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return deleted;
|
||||||
|
}
|
||||||
|
|
||||||
|
normalize(format) {
|
||||||
|
const self = this;
|
||||||
|
const headers = {};
|
||||||
|
|
||||||
|
utils.forEach(this, (value, header) => {
|
||||||
|
const key = utils.findKey(headers, header);
|
||||||
|
|
||||||
|
if (key) {
|
||||||
|
self[key] = normalizeValue(value);
|
||||||
|
delete self[header];
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
const normalized = format ? formatHeader(header) : String(header).trim();
|
||||||
|
|
||||||
|
if (normalized !== header) {
|
||||||
|
delete self[header];
|
||||||
|
}
|
||||||
|
|
||||||
|
self[normalized] = normalizeValue(value);
|
||||||
|
|
||||||
|
headers[normalized] = true;
|
||||||
|
});
|
||||||
|
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
|
||||||
|
concat(...targets) {
|
||||||
|
return this.constructor.concat(this, ...targets);
|
||||||
|
}
|
||||||
|
|
||||||
|
toJSON(asStrings) {
|
||||||
|
const obj = Object.create(null);
|
||||||
|
|
||||||
|
utils.forEach(this, (value, header) => {
|
||||||
|
value != null && value !== false && (obj[header] = asStrings && utils.isArray(value) ? value.join(', ') : value);
|
||||||
|
});
|
||||||
|
|
||||||
|
return obj;
|
||||||
|
}
|
||||||
|
|
||||||
|
[Symbol.iterator]() {
|
||||||
|
return Object.entries(this.toJSON())[Symbol.iterator]();
|
||||||
|
}
|
||||||
|
|
||||||
|
toString() {
|
||||||
|
return Object.entries(this.toJSON()).map(([header, value]) => header + ': ' + value).join('\n');
|
||||||
|
}
|
||||||
|
|
||||||
|
getSetCookie() {
|
||||||
|
return this.get("set-cookie") || [];
|
||||||
|
}
|
||||||
|
|
||||||
|
get [Symbol.toStringTag]() {
|
||||||
|
return 'AxiosHeaders';
|
||||||
|
}
|
||||||
|
|
||||||
|
static from(thing) {
|
||||||
|
return thing instanceof this ? thing : new this(thing);
|
||||||
|
}
|
||||||
|
|
||||||
|
static concat(first, ...targets) {
|
||||||
|
const computed = new this(first);
|
||||||
|
|
||||||
|
targets.forEach((target) => computed.set(target));
|
||||||
|
|
||||||
|
return computed;
|
||||||
|
}
|
||||||
|
|
||||||
|
static accessor(header) {
|
||||||
|
const internals = this[$internals] = (this[$internals] = {
|
||||||
|
accessors: {}
|
||||||
|
});
|
||||||
|
|
||||||
|
const accessors = internals.accessors;
|
||||||
|
const prototype = this.prototype;
|
||||||
|
|
||||||
|
function defineAccessor(_header) {
|
||||||
|
const lHeader = normalizeHeader(_header);
|
||||||
|
|
||||||
|
if (!accessors[lHeader]) {
|
||||||
|
buildAccessors(prototype, _header);
|
||||||
|
accessors[lHeader] = true;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
utils.isArray(header) ? header.forEach(defineAccessor) : defineAccessor(header);
|
||||||
|
|
||||||
|
return this;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
AxiosHeaders.accessor(['Content-Type', 'Content-Length', 'Accept', 'Accept-Encoding', 'User-Agent', 'Authorization']);
|
||||||
|
|
||||||
|
// reserved names hotfix
|
||||||
|
utils.reduceDescriptors(AxiosHeaders.prototype, ({value}, key) => {
|
||||||
|
let mapped = key[0].toUpperCase() + key.slice(1); // map `set` => `Set`
|
||||||
|
return {
|
||||||
|
get: () => value,
|
||||||
|
set(headerValue) {
|
||||||
|
this[mapped] = headerValue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
utils.freezeMethods(AxiosHeaders);
|
||||||
|
|
||||||
|
export default AxiosHeaders;
|
||||||
|
|
@ -0,0 +1,71 @@
|
||||||
|
'use strict';
|
||||||
|
|
||||||
|
import utils from './../utils.js';
|
||||||
|
|
||||||
|
class InterceptorManager {
|
||||||
|
constructor() {
|
||||||
|
this.handlers = [];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Add a new interceptor to the stack
|
||||||
|
*
|
||||||
|
* @param {Function} fulfilled The function to handle `then` for a `Promise`
|
||||||
|
* @param {Function} rejected The function to handle `reject` for a `Promise`
|
||||||
|
*
|
||||||
|
* @return {Number} An ID used to remove interceptor later
|
||||||
|
*/
|
||||||
|
use(fulfilled, rejected, options) {
|
||||||
|
this.handlers.push({
|
||||||
|
fulfilled,
|
||||||
|
rejected,
|
||||||
|
synchronous: options ? options.synchronous : false,
|
||||||
|
runWhen: options ? options.runWhen : null
|
||||||
|
});
|
||||||
|
return this.handlers.length - 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Remove an interceptor from the stack
|
||||||
|
*
|
||||||
|
* @param {Number} id The ID that was returned by `use`
|
||||||
|
*
|
||||||
|
* @returns {void}
|
||||||
|
*/
|
||||||
|
eject(id) {
|
||||||
|
if (this.handlers[id]) {
|
||||||
|
this.handlers[id] = null;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clear all interceptors from the stack
|
||||||
|
*
|
||||||
|
* @returns {void}
|
||||||
|
*/
|
||||||
|
clear() {
|
||||||
|
if (this.handlers) {
|
||||||
|
this.handlers = [];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Iterate over all the registered interceptors
|
||||||
|
*
|
||||||
|
* This method is particularly useful for skipping over any
|
||||||
|
* interceptors that may have become `null` calling `eject`.
|
||||||
|
*
|
||||||
|
* @param {Function} fn The function to call for each interceptor
|
||||||
|
*
|
||||||
|
* @returns {void}
|
||||||
|
*/
|
||||||
|
forEach(fn) {
|
||||||
|
utils.forEach(this.handlers, function forEachHandler(h) {
|
||||||
|
if (h !== null) {
|
||||||
|
fn(h);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export default InterceptorManager;
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
# axios // core
|
||||||
|
|
||||||
|
The modules found in `core/` should be modules that are specific to the domain logic of axios. These modules would most likely not make sense to be consumed outside of the axios module, as their logic is too specific. Some examples of core modules are:
|
||||||
|
|
||||||
|
- Dispatching requests
|
||||||
|
- Requests sent via `adapters/` (see lib/adapters/README.md)
|
||||||
|
- Managing interceptors
|
||||||
|
- Handling config
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue