Merge pull request #472 from manchenkoff/463-custom-params-login

feat: add optional fetch options to login/logout methods

Author: manchenkoff

docs/content/3.composables/1.useSanctumAuth.md

@@ -14,31 +14,68 @@ Composable provides 2 computed properties and 4 methods:
 - `login` - method for logging in the user
 - `logout` - method for logging out the user
 - `refreshIdentity` - method for manually re-fetching current authenticated user data
-- `checkSession` - method to validate existence of the session (cookie in the browser or token in the storage) 
+- `checkSession` - method to validate existence of the session (cookie in the browser or token in the storage)
 
-To authenticate a user you should pass the credentials payload as an argument to the `login` method. 
+To authenticate a user you should pass the credentials payload as an argument to the `login` method.
 The payload should contain all fields required by your Laravel Sanctum backend.
 
 ```typescript
 const { login } = useSanctumAuth();
 
 const userCredentials = {
-    email: '[email protected]',
-    password: '123123',
-};
+  email: "[email protected]",
+  password: "123123",
+}
 
-await login(userCredentials);
+await login(userCredentials)
 ```
 
-If the login operation was successful, the `user` property will be updated with 
+If the login operation was successful, the `user` property will be updated with
 the current user information returned by the Laravel API.
 
+If you do not want to update the `user` property automatically (e.g. *for 2FA authentication*),
+you can disable identity fetching by passing optional argument to `login` method:
+
+```typescript
+// user identity will not be loaded after successful response
+await login(userCredentials, false) 
+```
+
 By default, methods will use the following Laravel endpoints:
+
 - `/login` to authenticate the user
 - `/logout` to log out the user
 - `/api/user` to get the current user information
 - `/sanctum/csrf-cookie` to get the `CSRF` token cookie
 
 To change the default endpoints, please check the [Configuration](/usage/configuration) section.
 
+### Additional `fetch` options
+
+If you want to pass additional header or change HTTP method for either `login` or `logout` calls, 
+you can pass optional `options: SanctumFetchOptions` argument.
+
+For example, to log out the user with `DELETE` method instead of default `POST`:
+
+```typescript
+const { logout } = useSanctumAuth()
 
+await logout({ method: "DELETE" })
+```
+
+Use the same approach when you need to pass additional params to `login` call:
+
+```typescript
+const { login } = useSanctumAuth()
+
+const userCredentials = {
+  email: "[email protected]",
+  password: "123123",
+}
+
+await login(
+    userCredentials, 
+    false, 
+    { headers: { "X-Custom-Header": "header_value" } }
+)
+```

docs/package.json

@@ -14,25 +14,25 @@
     "validate": "pnpm lint && pnpm typecheck"
   },
   "dependencies": {
-    "@iconify-json/lucide": "^1.2.69",
-    "@iconify-json/simple-icons": "^1.2.54",
-    "@iconify-json/vscode-icons": "^1.2.31",
-    "@nuxt/content": "^3.7.1",
+    "@iconify-json/lucide": "^1.2.77",
+    "@iconify-json/simple-icons": "^1.2.61",
+    "@iconify-json/vscode-icons": "^1.2.37",
+    "@nuxt/content": "^3.9.0",
     "@nuxt/image": "^1.11.0",
-    "@nuxt/ui": "^4.0.1",
-    "better-sqlite3": "^12.4.1",
-    "nuxt": "^4.1.3",
+    "@nuxt/ui": "^4.2.1",
+    "better-sqlite3": "^12.5.0",
+    "nuxt": "^4.2.1",
     "nuxt-llms": "0.1.3",
-    "nuxt-og-image": "^5.1.11"
+    "nuxt-og-image": "^5.1.12"
   },
   "devDependencies": {
-    "@nuxt/eslint": "^1.9.0",
-    "eslint": "^9.37.0",
+    "@nuxt/eslint": "^1.11.0",
+    "eslint": "^9.39.1",
     "typescript": "^5.9.3",
-    "vue-tsc": "^3.1.1"
+    "vue-tsc": "^3.1.5"
   },
   "resolutions": {
     "unimport": "4.1.1"
   },
-  "packageManager": "pnpm@10.18.1+sha512.77a884a165cbba2d8d1c19e3b4880eee6d2fcabd0d879121e282196b80042351d5eb3ca0935fa599da1dc51265cc68816ad2bddd2a2de5ea9fdf92adbec7cd34"
+  "packageManager": "pnpm@10.24.0"
 }