From 2a3a3e6f588156a36ed0b302d72f84d6bdc82ac6 Mon Sep 17 00:00:00 2001 From: Mike Rudat Date: Sun, 2 Aug 2026 17:42:28 +0000 Subject: [PATCH 01/10] fix: sdk-angular typedoc/TS 6.0 incompatibility blocking docs generation. typedoc@0.25.13 only supports TypeScript up to 5.4, but sdk-angular runs TypeScript ~6.0.0 (bumped in the Angular 22 upgrade). Bump typedoc to ^0.28.20 (explicit TS 6.0.x support) and typedoc-plugin-markdown to ^4.12.0 (required peer range for typedoc 0.28.x). Also fix tsconfig.json's base types declaration: it still listed ["jasmine"] even though the Angular test runner was migrated to Vitest in the 2.0.0 release, causing typedoc's full-program type check to fail on *.spec.ts files referencing vitest globals (expect, it). Changed to ["vitest/globals", "node"], matching tsconfig.spec.json. This only affects tooling that reads the base tsconfig directly (typedoc, IDEs); the actual build/test tsconfigs (tsconfig.lib*.json, tsconfig.spec.json) already declare their own types and are unaffected. --- packages/sdk-angular/package.json | 4 +- packages/sdk-angular/tsconfig.json | 2 +- yarn.lock | 114 ++++++++++++++++++++++++++++- 3 files changed, 114 insertions(+), 6 deletions(-) diff --git a/packages/sdk-angular/package.json b/packages/sdk-angular/package.json index fcdb974..8409baf 100644 --- a/packages/sdk-angular/package.json +++ b/packages/sdk-angular/package.json @@ -27,8 +27,8 @@ "@angular/build": "^22.0.0", "@angular/cli": "^22.0.0", "@angular/compiler-cli": "^22.0.0", - "typedoc": "^0.25.13", - "typedoc-plugin-markdown": "^3.17.1", + "typedoc": "^0.28.20", + "typedoc-plugin-markdown": "^4.12.0", "jsdom": "^25.0.0", "ng-packagr": "^22.0.0", "typescript": "~6.0.0", diff --git a/packages/sdk-angular/tsconfig.json b/packages/sdk-angular/tsconfig.json index 6887e8e..fccc0be 100644 --- a/packages/sdk-angular/tsconfig.json +++ b/packages/sdk-angular/tsconfig.json @@ -27,7 +27,7 @@ "composite": false, "allowImportingTsExtensions": false, "noEmit": false, - "types": ["jasmine"] + "types": ["vitest/globals", "node"] }, "include": ["./**/*.ts"], "angularCompilerOptions": { diff --git a/yarn.lock b/yarn.lock index dac7ce9..65123c4 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1075,6 +1075,17 @@ resolved "https://registry.yarnpkg.com/@gar/promise-retry/-/promise-retry-1.0.3.tgz#65e726428e794bc4453948e0a41e6de4215ce8b0" integrity sha512-GmzA9ckNokPypTg10pgpeHNQe7ph+iIKKmhKu3Ob9ANkswreCx7R3cKmY781K8QK3AqVL3xVh9A42JvIAbkkSA== +"@gerrit0/mini-shiki@^3.23.0": + version "3.23.0" + resolved "https://registry.yarnpkg.com/@gerrit0/mini-shiki/-/mini-shiki-3.23.0.tgz#d9414f3080b88303b18f3a311846e37e424d800c" + integrity sha512-bEMORlG0cqdjVyCEuU0cDQbORWX+kYCeo0kV1lbxF5bt4r7SID2l9bqsxJEM0zndaxpOUT7riCyIVEuqq/Ynxg== + dependencies: + "@shikijs/engine-oniguruma" "^3.23.0" + "@shikijs/langs" "^3.23.0" + "@shikijs/themes" "^3.23.0" + "@shikijs/types" "^3.23.0" + "@shikijs/vscode-textmate" "^10.0.2" + "@harperfast/extended-iterable@^1.0.3": version "1.0.3" resolved "https://registry.yarnpkg.com/@harperfast/extended-iterable/-/extended-iterable-1.0.3.tgz#471489c5058331017e821bf6c33de70fc2c073ee" @@ -2962,6 +2973,41 @@ jsonc-parser "3.3.1" typescript "6.0.3" +"@shikijs/engine-oniguruma@^3.23.0": + version "3.23.0" + resolved "https://registry.yarnpkg.com/@shikijs/engine-oniguruma/-/engine-oniguruma-3.23.0.tgz#789421048d66ac1b33613169d6d18b9cc6e340ed" + integrity sha512-1nWINwKXxKKLqPibT5f4pAFLej9oZzQTsby8942OTlsJzOBZ0MWKiwzMsd+jhzu8YPCHAswGnnN1YtQfirL35g== + dependencies: + "@shikijs/types" "3.23.0" + "@shikijs/vscode-textmate" "^10.0.2" + +"@shikijs/langs@^3.23.0": + version "3.23.0" + resolved "https://registry.yarnpkg.com/@shikijs/langs/-/langs-3.23.0.tgz#00959d8b16c7f671221ae79b3ad8cde7e6a5c112" + integrity sha512-2Ep4W3Re5aB1/62RSYQInK9mM3HsLeB91cHqznAJMuylqjzNVAVCMnNWRHFtcNHXsoNRayP9z1qj4Sq3nMqYXg== + dependencies: + "@shikijs/types" "3.23.0" + +"@shikijs/themes@^3.23.0": + version "3.23.0" + resolved "https://registry.yarnpkg.com/@shikijs/themes/-/themes-3.23.0.tgz#fd96ca5ad52639057995bc2093682884e1846f27" + integrity sha512-5qySYa1ZgAT18HR/ypENL9cUSGOeI2x+4IvYJu4JgVJdizn6kG4ia5Q1jDEOi7gTbN4RbuYtmHh0W3eccOrjMA== + dependencies: + "@shikijs/types" "3.23.0" + +"@shikijs/types@3.23.0", "@shikijs/types@^3.23.0": + version "3.23.0" + resolved "https://registry.yarnpkg.com/@shikijs/types/-/types-3.23.0.tgz#d441571a058641926018ae3de99866f39e5bbdf2" + integrity sha512-3JZ5HXOZfYjsYSk0yPwBrkupyYSLpAE26Qc0HLghhZNGTZg/SKxXIIgoxOpmmeQP0RRSDJTk1/vPfw9tbw+jSQ== + dependencies: + "@shikijs/vscode-textmate" "^10.0.2" + "@types/hast" "^3.0.4" + +"@shikijs/vscode-textmate@^10.0.2": + version "10.0.2" + resolved "https://registry.yarnpkg.com/@shikijs/vscode-textmate/-/vscode-textmate-10.0.2.tgz#a90ab31d0cc1dfb54c66a69e515bf624fa7b2224" + integrity sha512-83yeghZ2xxin3Nj8z1NMd/NCuca+gsYXswywDy5bHvwlWL8tpTQmzGeUuHd9FC3E/SBEMvzJRwWEOz5gGes9Qg== + "@sigstore/bundle@^4.0.0": version "4.0.0" resolved "https://registry.yarnpkg.com/@sigstore/bundle/-/bundle-4.0.0.tgz#854eda43eb6a59352037e49000177c8904572f83" @@ -3247,6 +3293,13 @@ resolved "https://registry.yarnpkg.com/@types/estree/-/estree-1.0.8.tgz#958b91c991b1867ced318bedea0e215ee050726e" integrity sha512-dWHzHa2WqEXI/O1E9OjrocMTKJl2mSrEolh1Iomrv6U+JuNwaHXsXx9bLu5gG7BUWFIN0skIQJQ/L1rIex4X6w== +"@types/hast@^3.0.4": + version "3.0.5" + resolved "https://registry.yarnpkg.com/@types/hast/-/hast-3.0.5.tgz#48020de4c0e63492f4ca9db42068c108f68b7f8f" + integrity sha512-rp/ezSWaD1m44dPKICGhiskI13nVr7qTloFwDa/IYkhhf5nzwP+zIQcIJh3WIFSBOy/H1PzB40jPjMDksN4F+g== + dependencies: + "@types/unist" "*" + "@types/js-cookie@3.0.6": version "3.0.6" resolved "https://registry.yarnpkg.com/@types/js-cookie/-/js-cookie-3.0.6.tgz#a04ca19e877687bd449f5ad37d33b104b71fdf95" @@ -3288,6 +3341,11 @@ resolved "https://registry.yarnpkg.com/@types/resolve/-/resolve-1.20.2.tgz#97d26e00cd4a0423b4af620abecf3e6f442b7975" integrity sha512-60BCwRFOZCQhDncwQdxxeOEEkbc5dIMccYLwbxsS4TUNeVECQ/pBJ0j09mrHOl/JJvpRPGwO9SvE4nR2Nb/a4Q== +"@types/unist@*": + version "3.0.3" + resolved "https://registry.yarnpkg.com/@types/unist/-/unist-3.0.3.tgz#acaab0f919ce69cce629c2d4ed2eb4adc1b6c20c" + integrity sha512-ko/gIFJRv177XgZsZcBwnqJN5x/Gien8qNOn0D5bQU/zAzVf9Zt3BlcUiLqhV9y4ARk0GbT3tnUiPNgnTXzc/Q== + "@typescript-eslint/eslint-plugin@^7.2.0": version "7.18.0" resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin/-/eslint-plugin-7.18.0.tgz#b16d3cf3ee76bf572fdf511e79c248bdec619ea3" @@ -5365,7 +5423,7 @@ enhanced-resolve@^5.14.1: graceful-fs "^4.2.4" tapable "^2.3.3" -entities@^4.2.0: +entities@^4.2.0, entities@^4.5.0: version "4.5.0" resolved "https://registry.yarnpkg.com/entities/-/entities-4.5.0.tgz#5d268ea5e7113ec74c4d033b79ea5a35a488fb48" integrity sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw== @@ -7543,6 +7601,13 @@ lilconfig@^3.1.3: resolved "https://registry.yarnpkg.com/lilconfig/-/lilconfig-3.1.3.tgz#a1bcfd6257f9585bf5ae14ceeebb7b559025e4c4" integrity sha512-/vlFKAoH5Cgt3Ie+JLhRbwOsCQePABiU3tJ1egGvyQ+33R/vcwM2Zl2QR/LzjsBeItPt3oSVXapn+m4nQDvpzw== +linkify-it@^5.0.2: + version "5.0.2" + resolved "https://registry.yarnpkg.com/linkify-it/-/linkify-it-5.0.2.tgz#d3be0a693af3da9df3883f1e346a0e97461a8c19" + integrity sha512-ONTm2jCMAVZjgQa/Fy1kScXsuOoF5NPTsoFBdE1KVIZ2vAh/r9+Bqo+0jINCBYnavTPQZz38QzFTme79ENoN3Q== + dependencies: + uc.micro "^2.0.0" + lint-staged@^15.2.2: version "15.5.2" resolved "https://registry.yarnpkg.com/lint-staged/-/lint-staged-15.5.2.tgz#beff028fd0681f7db26ffbb67050a21ed4d059a3" @@ -7813,6 +7878,18 @@ make-fetch-happen@^15.0.0, make-fetch-happen@^15.0.1, make-fetch-happen@^15.0.4: proc-log "^6.0.0" ssri "^13.0.0" +markdown-it@^14.3.0: + version "14.3.0" + resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-14.3.0.tgz#8542fa5506e3530f7e2b08dc3885630135c5620e" + integrity sha512-RCEsPjR+sr0x+AuYp601tKTkgFG4YEPLCzHST3cQ/fhlJkqAkz1L2/Qbp1j9qw5SBwQHFBoW8+hoN5xssOF0Tw== + dependencies: + argparse "^2.0.1" + entities "^4.5.0" + linkify-it "^5.0.2" + mdurl "^2.0.0" + punycode.js "^2.3.1" + uc.micro "^2.1.0" + marked@^4.3.0: version "4.3.0" resolved "https://registry.yarnpkg.com/marked/-/marked-4.3.0.tgz#796362821b019f734054582038b116481b456cf3" @@ -7833,6 +7910,11 @@ mdn-data@2.27.1: resolved "https://registry.yarnpkg.com/mdn-data/-/mdn-data-2.27.1.tgz#e37b9c50880b75366c4d40ac63d9bbcacdb61f0e" integrity sha512-9Yubnt3e8A0OKwxYSXyhLymGW4sCufcLG6VdiDdUGVkPhpqLxlvP5vl1983gQjJl3tqbrM731mjaZaP68AgosQ== +mdurl@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/mdurl/-/mdurl-2.1.0.tgz#d711d3f7bce7f22c487c91be78545f356fa96573" + integrity sha512-1+HBaOx0zi/dQWht8rNv9MYf9qqpqL/kxI0hXImU6Y547zM6Sni8BQibt7ifgMcYtQg41ao3Ivd6cnSM86inpg== + media-typer@^1.1.0: version "1.1.1" resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-1.1.1.tgz#6f035400dfe3ab9d5607bc77546ce30cc2f9c6b8" @@ -7917,7 +7999,7 @@ minimatch@10.2.3: dependencies: brace-expansion "^5.0.2" -minimatch@^10.0.3, minimatch@^10.1.1, minimatch@^10.2.2: +minimatch@^10.0.3, minimatch@^10.1.1, minimatch@^10.2.2, minimatch@^10.2.5: version "10.2.6" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-10.2.6.tgz#fd956bbe0b77241e9f15ac5dccb1c638060968ef" integrity sha512-vpLQEs+VLCr1nU0BXS07maYoFwlDAH0gngQuuttxIwutDFEMHq2blX+8vpgxDdK3J1PwjCJiep77OitTZ4Ll1A== @@ -9492,6 +9574,11 @@ pug@^3.0.2: pug-runtime "^3.0.1" pug-strip-comments "^2.0.0" +punycode.js@^2.3.1: + version "2.3.1" + resolved "https://registry.yarnpkg.com/punycode.js/-/punycode.js-2.3.1.tgz#6b53e56ad75588234e79f4affa90972c7dd8cdb7" + integrity sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA== + punycode@^2.1.0, punycode@^2.1.1, punycode@^2.3.1: version "2.3.1" resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.1.tgz#027422e2faec0b25e1549c3e1bd8309b9133b6e5" @@ -10941,6 +11028,11 @@ typedoc-plugin-markdown@^3.17.1: dependencies: handlebars "^4.7.7" +typedoc-plugin-markdown@^4.12.0: + version "4.12.0" + resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-4.12.0.tgz#94d008b5212f43303edc9578c3031f542f16cae4" + integrity sha512-eJDEMAfxCmede22c/Jw7d0FA13ggAQv+KkwQYKYCdqI02cin6Rc9QRwbG/7XvvHWinuFejySnZVUWDtvGk3Vbg== + typedoc@^0.25.13: version "0.25.13" resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.25.13.tgz#9a98819e3b2d155a6d78589b46fa4c03768f0922" @@ -10951,6 +11043,17 @@ typedoc@^0.25.13: minimatch "^9.0.3" shiki "^0.14.7" +typedoc@^0.28.20: + version "0.28.20" + resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.28.20.tgz#23c9c841587c528b56cf9c0d017ca717745bb0d9" + integrity sha512-uSKqkh8Cr48vllnEy+jdaAgOeR6Y+QCBW7usgUsKj7gJEfR7stw9U/fE49LBnj2tPRKPY0c0EBJSWe9Appmplg== + dependencies: + "@gerrit0/mini-shiki" "^3.23.0" + lunr "^2.3.9" + markdown-it "^14.3.0" + minimatch "^10.2.5" + yaml "^2.9.0" + typescript@5.4.2: version "5.4.2" resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.4.2.tgz#0ae9cebcfae970718474fe0da2c090cad6577372" @@ -10966,6 +11069,11 @@ typescript@6.0.3, typescript@~6.0.0: resolved "https://registry.yarnpkg.com/typescript/-/typescript-6.0.3.tgz#90251dc007916e972786cb94d74d15b185577d21" integrity sha512-y2TvuxSZPDyQakkFRPZHKFm+KKVqIisdg9/CZwm9ftvKXLP8NRWj38/ODjNbr43SsoXqNuAisEf1GdCxqWcdBw== +uc.micro@^2.0.0, uc.micro@^2.1.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/uc.micro/-/uc.micro-2.1.0.tgz#f8d3f7d0ec4c3dea35a7e3c8efa4cb8b45c9e7ee" + integrity sha512-ARDJmphmdvUk6Glw7y9DQ2bFkKBHwQHLi2lsaH6PPmz/Ka9sFOBsBluozhDltWmnv9u/cF6Rt87znRTPV+yp/A== + ufo@^1.1.2, ufo@^1.6.1, ufo@^1.6.3, ufo@^1.6.4: version "1.6.4" resolved "https://registry.yarnpkg.com/ufo/-/ufo-1.6.4.tgz#7a8fb875fcc6382d2c7d0b3692738b0500a92467" @@ -11800,7 +11908,7 @@ yallist@^5.0.0: resolved "https://registry.yarnpkg.com/yallist/-/yallist-5.0.0.tgz#00e2de443639ed0d78fd87de0d27469fbcffb533" integrity sha512-YgvUTfwqyc7UXVMrB+SImsVYSmTS8X/tSrtdNZMImM+n7+QTriRXyXim0mBrTXNeqzVF0KWGgHPeiyViFFrNDw== -yaml@^2.7.0, yaml@^2.8.2: +yaml@^2.7.0, yaml@^2.8.2, yaml@^2.9.0: version "2.9.0" resolved "https://registry.yarnpkg.com/yaml/-/yaml-2.9.0.tgz#78274afd93598a1dfdd6130df6a566defcbf9aa4" integrity sha512-2AvhNX3mb8zd6Zy7INTtSpl1F15HW6Wnqj0srWlkKLcpYl/gMIMJiyuGq2KeI2YFxUPjdlB+3Lc10seMLtL4cA== From 2d9af72c9bed501cbc80b584411e66e73a4cc15c Mon Sep 17 00:00:00 2001 From: Mike Rudat Date: Sun, 2 Aug 2026 17:42:38 +0000 Subject: [PATCH 02/10] docs: add Resource Server Guidance to DPoP Mode docs, regenerate typedoc output. ENG-4791: Add a Resource Server Guidance subsection under DPoP Mode in each SDK's README (React, Vue, Angular), covering guidance for backend developers validating FusionAuth-issued DPoP tokens: - The SDK does not implement jti replay prevention; that's the resource server's responsibility (in-memory Map+TTL for single instance, Redis or similar for horizontally scaled deployments). - htu validation and reverse-proxy trust-proxy considerations. - The Authorization header uses the DPoP scheme, not Bearer. Also regenerate the typedoc output (yarn docs) for all three SDKs, which was stale and had no mention of the DPoP API surface (dpopFetch, generateProof, getAccessToken, useDpop, dpopTokenStorage, etc.). --- packages/sdk-angular/README.md | 11 + packages/sdk-angular/docs/.nojekyll | 1 - packages/sdk-angular/docs/README.md | 4 +- .../FusionAuthAccountButtonComponent.md | 56 +--- .../classes/FusionAuthLoginButtonComponent.md | 63 ++-- .../FusionAuthLogoutButtonComponent.md | 56 +--- .../docs/classes/FusionAuthModule.md | 38 +-- .../FusionAuthRegisterButtonComponent.md | 63 ++-- .../docs/classes/FusionAuthService.md | 294 ++++++++++-------- .../docs/{modules.md => globals.md} | 10 +- .../docs/interfaces/FusionAuthConfig.md | 208 ++++++------- .../sdk-angular/docs/interfaces/UserInfo.md | 174 ++++------- packages/sdk-react/README.md | 11 + packages/sdk-react/docs/README.md | 43 +++ ...ProviderConfig.FusionAuthProviderConfig.md | 107 ++++--- ...oviderContext.FusionAuthProviderContext.md | 143 +++++++-- .../modules/providers_FusionAuthProvider.md | 24 +- .../docs/modules/ui_FusionAuthLoginButton.md | 6 +- .../docs/modules/ui_FusionAuthLogoutButton.md | 6 +- .../modules/ui_FusionAuthRegisterButton.md | 6 +- .../sdk-react/docs/modules/ui_RequireAuth.md | 6 +- .../docs/modules/ui_Unauthenticated.md | 8 +- packages/sdk-vue/README.md | 11 + packages/sdk-vue/docs/README.md | 69 +++- .../sdk-vue/docs/interfaces/FusionAuth.md | 147 +++++++-- .../docs/interfaces/FusionAuthConfig.md | 127 +++++--- packages/sdk-vue/docs/interfaces/UserInfo.md | 94 +++--- packages/sdk-vue/docs/modules.md | 42 +-- 28 files changed, 1026 insertions(+), 802 deletions(-) delete mode 100644 packages/sdk-angular/docs/.nojekyll rename packages/sdk-angular/docs/{modules.md => globals.md} (85%) diff --git a/packages/sdk-angular/README.md b/packages/sdk-angular/README.md index 693ea5d..3fc87df 100644 --- a/packages/sdk-angular/README.md +++ b/packages/sdk-angular/README.md @@ -12,6 +12,7 @@ An SDK for using FusionAuth in Angular applications. - [State Parameter](#state-parameter) - [SSR](#ssr) - [DPoP Mode](#dpop-mode) + - [Resource Server Guidance](#resource-server-guidance) - [Known issues](#known-issues) - [Documentation](#documentation) - [Releases](#releases) @@ -221,6 +222,16 @@ class AppComponent { } ``` +#### Resource Server Guidance + +If you're building a resource server that validates FusionAuth-issued DPoP tokens (this guidance applies regardless of which SDK, if any, the resource server itself uses): + +- This SDK does not implement `jti` replay prevention — tracking which proof JTIs have already been seen, and rejecting duplicates, is the resource server's responsibility. + - Single-instance deployments: an in-memory `Map` with TTL-based eviction is sufficient. + - Horizontally scaled deployments: a distributed store (e.g. Redis) is required, since replay state must be shared across instances. +- Validate the proof's `htu` claim against the request's actual URL. If the resource server sits behind a reverse proxy, ensure it's configured to trust the proxy and expose the public-facing URL (not an internal one) for this comparison. +- The `Authorization` header uses the `DPoP` scheme, not `Bearer` — resource servers must accept `Authorization: DPoP `. + ### Known Issues None. diff --git a/packages/sdk-angular/docs/.nojekyll b/packages/sdk-angular/docs/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/packages/sdk-angular/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/packages/sdk-angular/docs/README.md b/packages/sdk-angular/docs/README.md index 179c520..92311f2 100644 --- a/packages/sdk-angular/docs/README.md +++ b/packages/sdk-angular/docs/README.md @@ -1,4 +1,6 @@ -@fusionauth/angular-sdk / [Exports](modules.md) +**@fusionauth/angular-sdk** + +*** # FusionauthAngularSdk diff --git a/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md index 476907d..0176665 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md @@ -1,61 +1,39 @@ -[@fusionauth/angular-sdk](../README.md) / [Exports](../modules.md) / FusionAuthAccountButtonComponent +[**@fusionauth/angular-sdk**](../README.md) -# Class: FusionAuthAccountButtonComponent - -## Table of contents - -### Constructors - -- [constructor](FusionAuthAccountButtonComponent.md#constructor) - -### Properties +*** -- [fusionAuth](FusionAuthAccountButtonComponent.md#fusionauth) +[@fusionauth/angular-sdk](../globals.md) / FusionAuthAccountButtonComponent -### Methods +# Class: FusionAuthAccountButtonComponent -- [manageAccount](FusionAuthAccountButtonComponent.md#manageaccount) +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L10) ## Constructors -### constructor - -• **new FusionAuthAccountButtonComponent**(`fusionAuth`): [`FusionAuthAccountButtonComponent`](FusionAuthAccountButtonComponent.md) - -#### Parameters - -| Name | Type | -| :----------- | :------------------------------------------------------------------------------------- | -| `fusionAuth` | [`FusionAuthService`](FusionAuthService.md)\<[`UserInfo`](../interfaces/UserInfo.md)\> | - -#### Returns +### Constructor -[`FusionAuthAccountButtonComponent`](FusionAuthAccountButtonComponent.md) +> **new FusionAuthAccountButtonComponent**(`fusionAuth`): `FusionAuthAccountButtonComponent` -#### Defined in +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L11) -[lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L10) - -## Properties +#### Parameters -### fusionAuth +##### fusionAuth -• `Private` **fusionAuth**: [`FusionAuthService`](FusionAuthService.md)\<[`UserInfo`](../interfaces/UserInfo.md)\> +[`FusionAuthService`](FusionAuthService.md) -#### Defined in +#### Returns -[lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L10) +`FusionAuthAccountButtonComponent` ## Methods -### manageAccount +### manageAccount() + +> **manageAccount**(): `void` -▸ **manageAccount**(): `void` +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L13) #### Returns `void` - -#### Defined in - -[lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts:12](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L12) diff --git a/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md index 0722cf8..05836f4 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md @@ -1,72 +1,47 @@ -[@fusionauth/angular-sdk](../README.md) / [Exports](../modules.md) / FusionAuthLoginButtonComponent +[**@fusionauth/angular-sdk**](../README.md) -# Class: FusionAuthLoginButtonComponent - -## Table of contents - -### Constructors - -- [constructor](FusionAuthLoginButtonComponent.md#constructor) - -### Properties +*** -- [fusionAuth](FusionAuthLoginButtonComponent.md#fusionauth) -- [state](FusionAuthLoginButtonComponent.md#state) +[@fusionauth/angular-sdk](../globals.md) / FusionAuthLoginButtonComponent -### Methods +# Class: FusionAuthLoginButtonComponent -- [login](FusionAuthLoginButtonComponent.md#login) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L10) ## Constructors -### constructor +### Constructor + +> **new FusionAuthLoginButtonComponent**(`fusionAuth`): `FusionAuthLoginButtonComponent` -• **new FusionAuthLoginButtonComponent**(`fusionAuth`): [`FusionAuthLoginButtonComponent`](FusionAuthLoginButtonComponent.md) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L13) #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------------------------------------- | -| `fusionAuth` | [`FusionAuthService`](FusionAuthService.md)\<[`UserInfo`](../interfaces/UserInfo.md)\> | +##### fusionAuth -#### Returns +[`FusionAuthService`](FusionAuthService.md) -[`FusionAuthLoginButtonComponent`](FusionAuthLoginButtonComponent.md) - -#### Defined in +#### Returns -[lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts:12](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L12) +`FusionAuthLoginButtonComponent` ## Properties -### fusionAuth - -• `Private` **fusionAuth**: [`FusionAuthService`](FusionAuthService.md)\<[`UserInfo`](../interfaces/UserInfo.md)\> - -#### Defined in - -[lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts:12](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L12) - ---- - ### state -• **state**: `undefined` \| `string` +> **state**: `string` \| `undefined` -#### Defined in - -[lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L10) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L11) ## Methods -### login +### login() + +> **login**(): `void` -▸ **login**(): `void` +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L15) #### Returns `void` - -#### Defined in - -[lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L14) diff --git a/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md index fec4fe4..03c8bb1 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md @@ -1,61 +1,39 @@ -[@fusionauth/angular-sdk](../README.md) / [Exports](../modules.md) / FusionAuthLogoutButtonComponent +[**@fusionauth/angular-sdk**](../README.md) -# Class: FusionAuthLogoutButtonComponent - -## Table of contents - -### Constructors - -- [constructor](FusionAuthLogoutButtonComponent.md#constructor) - -### Properties +*** -- [fusionAuth](FusionAuthLogoutButtonComponent.md#fusionauth) +[@fusionauth/angular-sdk](../globals.md) / FusionAuthLogoutButtonComponent -### Methods +# Class: FusionAuthLogoutButtonComponent -- [logout](FusionAuthLogoutButtonComponent.md#logout) +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L13) ## Constructors -### constructor - -• **new FusionAuthLogoutButtonComponent**(`fusionAuth`): [`FusionAuthLogoutButtonComponent`](FusionAuthLogoutButtonComponent.md) - -#### Parameters - -| Name | Type | -| :----------- | :------------------------------------------------------------------------------------- | -| `fusionAuth` | [`FusionAuthService`](FusionAuthService.md)\<[`UserInfo`](../interfaces/UserInfo.md)\> | - -#### Returns +### Constructor -[`FusionAuthLogoutButtonComponent`](FusionAuthLogoutButtonComponent.md) +> **new FusionAuthLogoutButtonComponent**(`fusionAuth`): `FusionAuthLogoutButtonComponent` -#### Defined in +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L14) -[lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L10) - -## Properties +#### Parameters -### fusionAuth +##### fusionAuth -• `Private` **fusionAuth**: [`FusionAuthService`](FusionAuthService.md)\<[`UserInfo`](../interfaces/UserInfo.md)\> +[`FusionAuthService`](FusionAuthService.md) -#### Defined in +#### Returns -[lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L10) +`FusionAuthLogoutButtonComponent` ## Methods -### logout +### logout() + +> **logout**(): `void` -▸ **logout**(): `void` +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L16) #### Returns `void` - -#### Defined in - -[lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:12](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L12) diff --git a/packages/sdk-angular/docs/classes/FusionAuthModule.md b/packages/sdk-angular/docs/classes/FusionAuthModule.md index 7465f17..37552f8 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthModule.md +++ b/packages/sdk-angular/docs/classes/FusionAuthModule.md @@ -1,43 +1,37 @@ -[@fusionauth/angular-sdk](../README.md) / [Exports](../modules.md) / FusionAuthModule +[**@fusionauth/angular-sdk**](../README.md) -# Class: FusionAuthModule - -## Table of contents +*** -### Constructors +[@fusionauth/angular-sdk](../globals.md) / FusionAuthModule -- [constructor](FusionAuthModule.md#constructor) - -### Methods +# Class: FusionAuthModule -- [forRoot](FusionAuthModule.md#forroot) +Defined in: [fusion-auth.module.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L25) ## Constructors -### constructor +### Constructor -• **new FusionAuthModule**(): [`FusionAuthModule`](FusionAuthModule.md) +> **new FusionAuthModule**(): `FusionAuthModule` #### Returns -[`FusionAuthModule`](FusionAuthModule.md) +`FusionAuthModule` ## Methods -### forRoot +### forRoot() -▸ **forRoot**(`fusionAuthConfig`): `ModuleWithProviders`\<[`FusionAuthModule`](FusionAuthModule.md)\> +> `static` **forRoot**(`fusionAuthConfig`): `ModuleWithProviders`\<`FusionAuthModule`\> -#### Parameters +Defined in: [fusion-auth.module.ts:26](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L26) -| Name | Type | -| :----------------- | :------------------------------------------------------ | -| `fusionAuthConfig` | [`FusionAuthConfig`](../interfaces/FusionAuthConfig.md) | +#### Parameters -#### Returns +##### fusionAuthConfig -`ModuleWithProviders`\<[`FusionAuthModule`](FusionAuthModule.md)\> +[`FusionAuthConfig`](../interfaces/FusionAuthConfig.md) -#### Defined in +#### Returns -[lib/fusion-auth.module.ts:26](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L26) +`ModuleWithProviders`\<`FusionAuthModule`\> diff --git a/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md index 8b75c77..801450a 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md @@ -1,72 +1,47 @@ -[@fusionauth/angular-sdk](../README.md) / [Exports](../modules.md) / FusionAuthRegisterButtonComponent +[**@fusionauth/angular-sdk**](../README.md) -# Class: FusionAuthRegisterButtonComponent - -## Table of contents - -### Constructors - -- [constructor](FusionAuthRegisterButtonComponent.md#constructor) - -### Properties +*** -- [fusionAuth](FusionAuthRegisterButtonComponent.md#fusionauth) -- [state](FusionAuthRegisterButtonComponent.md#state) +[@fusionauth/angular-sdk](../globals.md) / FusionAuthRegisterButtonComponent -### Methods +# Class: FusionAuthRegisterButtonComponent -- [register](FusionAuthRegisterButtonComponent.md#register) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L13) ## Constructors -### constructor +### Constructor + +> **new FusionAuthRegisterButtonComponent**(`fusionAuth`): `FusionAuthRegisterButtonComponent` -• **new FusionAuthRegisterButtonComponent**(`fusionAuth`): [`FusionAuthRegisterButtonComponent`](FusionAuthRegisterButtonComponent.md) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L16) #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------------------------------------- | -| `fusionAuth` | [`FusionAuthService`](FusionAuthService.md)\<[`UserInfo`](../interfaces/UserInfo.md)\> | +##### fusionAuth -#### Returns +[`FusionAuthService`](FusionAuthService.md) -[`FusionAuthRegisterButtonComponent`](FusionAuthRegisterButtonComponent.md) - -#### Defined in +#### Returns -[lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts:12](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L12) +`FusionAuthRegisterButtonComponent` ## Properties -### fusionAuth - -• `Private` **fusionAuth**: [`FusionAuthService`](FusionAuthService.md)\<[`UserInfo`](../interfaces/UserInfo.md)\> - -#### Defined in - -[lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts:12](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L12) - ---- - ### state -• **state**: `undefined` \| `string` +> **state**: `string` \| `undefined` -#### Defined in - -[lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L10) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L14) ## Methods -### register +### register() + +> **register**(): `void` -▸ **register**(): `void` +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L18) #### Returns `void` - -#### Defined in - -[lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L14) diff --git a/packages/sdk-angular/docs/classes/FusionAuthService.md b/packages/sdk-angular/docs/classes/FusionAuthService.md index 3ca445c..cb8d5ac 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthService.md +++ b/packages/sdk-angular/docs/classes/FusionAuthService.md @@ -1,164 +1,212 @@ -[@fusionauth/angular-sdk](../README.md) / [Exports](../modules.md) / FusionAuthService +[**@fusionauth/angular-sdk**](../README.md) + +*** + +[@fusionauth/angular-sdk](../globals.md) / FusionAuthService # Class: FusionAuthService\ +Defined in: [fusion-auth.service.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L24) + Service class to use with FusionAuth backend endpoints. -## Type parameters +## Type Parameters -| Name | Type | -| :--- | :-------------------------------------- | -| `T` | [`UserInfo`](../interfaces/UserInfo.md) | +### T -## Table of contents +`T` = [`UserInfo`](../interfaces/UserInfo.md) -### Constructors +## Constructors -- [constructor](FusionAuthService.md#constructor) +### Constructor -### Properties +> **new FusionAuthService**\<`T`\>(`config`, `platformId`, `ngZone`, `appRef`): `FusionAuthService`\<`T`\> -- [autoRefreshTimer](FusionAuthService.md#autorefreshtimer) -- [core](FusionAuthService.md#core) -- [isLoggedIn$](FusionAuthService.md#isloggedin$) -- [isLoggedInSubject](FusionAuthService.md#isloggedinsubject) +Defined in: [fusion-auth.service.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L29) -### Methods +#### Parameters -- [getUserInfo](FusionAuthService.md#getuserinfo) -- [getUserInfoObservable](FusionAuthService.md#getuserinfoobservable) -- [initAutoRefresh](FusionAuthService.md#initautorefresh) -- [isLoggedIn](FusionAuthService.md#isloggedin) -- [logout](FusionAuthService.md#logout) -- [manageAccount](FusionAuthService.md#manageaccount) -- [refreshToken](FusionAuthService.md#refreshtoken) -- [startLogin](FusionAuthService.md#startlogin) -- [startRegistration](FusionAuthService.md#startregistration) +##### config -## Constructors +[`FusionAuthConfig`](../interfaces/FusionAuthConfig.md) + +##### platformId + +`Object` + +##### ngZone + +`NgZone` + +##### appRef + +`ApplicationRef` + +#### Returns + +`FusionAuthService`\<`T`\> + +## Properties -### constructor +### isLoggedIn$ + +> **isLoggedIn$**: `Observable`\<`boolean`\> + +Defined in: [fusion-auth.service.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L68) + +An observable representing whether the user is logged in. -• **new FusionAuthService**\<`T`\>(`config`, `platformId`): [`FusionAuthService`](FusionAuthService.md)\<`T`\> +*** -#### Type parameters +### isLoggedInSignal -| Name | Type | -| :--- | :-------------------------------------- | -| `T` | [`UserInfo`](../interfaces/UserInfo.md) | +> **isLoggedInSignal**: `Signal`\<`boolean`\> + +Defined in: [fusion-auth.service.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L73) + +A Signal representing whether the user is logged in. + +## Methods + +### dpopFetch() + +> **dpopFetch**(`input`, `init?`): `Promise`\<`Response`\> + +Defined in: [fusion-auth.service.ts:177](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L177) + +DPoP mode `fetch()` wrapper that automatically attaches DPoP proof +headers. #### Parameters -| Name | Type | -| :----------- | :------------------------------------------------------ | -| `config` | [`FusionAuthConfig`](../interfaces/FusionAuthConfig.md) | -| `platformId` | `Object` | +##### input + +`URL` \| `RequestInfo` + +##### init? + +`RequestInit` #### Returns -[`FusionAuthService`](FusionAuthService.md)\<`T`\> +`Promise`\<`Response`\> -#### Defined in +#### Throws -[lib/fusion-auth.service.ts:21](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L21) +if called when `useDpop` is not enabled. -## Properties +*** -### autoRefreshTimer +### generateProof() -• `Private` `Optional` **autoRefreshTimer**: `Timeout` +> **generateProof**(`htu`, `htm`, `accessToken?`, `nonce?`): `Promise`\<`string`\> -#### Defined in +Defined in: [fusion-auth.service.ts:189](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L189) -[lib/fusion-auth.service.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L18) +Returns a signed DPoP proof JWT for use with axios or other +HTTP libraries that can't use [dpopFetch](#dpopfetch). ---- +#### Parameters -### core +##### htu -• `Private` **core**: `SDKCore` +`string` -#### Defined in +##### htm -[lib/fusion-auth.service.ts:17](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L17) +`string` ---- +##### accessToken? -### isLoggedIn$ +`string` -• **isLoggedIn$**: `Observable`\<`boolean`\> +##### nonce? -An observable representing whether the user is logged in. +`string` -#### Defined in +#### Returns -[lib/fusion-auth.service.ts:44](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L44) +`Promise`\<`string`\> ---- +#### Throws -### isLoggedInSubject +if called when `useDpop` is not enabled. -• `Private` **isLoggedInSubject**: `BehaviorSubject`\<`boolean`\> +*** -#### Defined in +### getAccessToken() -[lib/fusion-auth.service.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L19) +> **getAccessToken**(): `string` \| `null` -## Methods +Defined in: [fusion-auth.service.ts:202](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L202) + +Returns the stored DPoP access token, or `null` if not logged in. + +#### Returns -### getUserInfo +`string` \| `null` -▸ **getUserInfo**\<`T`\>(): `Promise`\<`T`\> +#### Throws + +if called when `useDpop` is not enabled. + +*** + +### getUserInfo() + +> **getUserInfo**\<`T`\>(): `Promise`\<`T`\> + +Defined in: [fusion-auth.service.ts:131](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L131) Fetches userInfo from the 'me' endpoint. -#### Type parameters +#### Type Parameters + +##### T -| Name | -| :--- | -| `T` | +`T` #### Returns `Promise`\<`T`\> -**`Throws`** +#### Throws - if an error occurred while fetching. -#### Defined in +*** -[lib/fusion-auth.service.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L102) +### getUserInfoObservable() ---- +> **getUserInfoObservable**(`callbacks?`): `Observable`\<`T`\> -### getUserInfoObservable - -▸ **getUserInfoObservable**(`callbacks?`): `Observable`\<`T`\> +Defined in: [fusion-auth.service.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L103) Returns an observable request that fetches userInfo, and catches error. #### Parameters -| Name | Type | -| :------------------- | :----------- | -| `callbacks?` | `Object` | -| `callbacks.onBegin?` | () => `void` | -| `callbacks.onDone?` | () => `void` | +##### callbacks? + +###### onBegin? + +() => `void` + +###### onDone? + +() => `void` #### Returns `Observable`\<`T`\> -#### Defined in - -[lib/fusion-auth.service.ts:74](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L74) +*** ---- +### initAutoRefresh() -### initAutoRefresh +> **initAutoRefresh**(): `void` -▸ **initAutoRefresh**(): `void` +Defined in: [fusion-auth.service.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L92) Initializes automatic access token refreshing. This is handled automatically if the SDK is configured with `shouldAutoRefresh`. @@ -167,15 +215,13 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. `void` -#### Defined in +*** -[lib/fusion-auth.service.ts:63](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L63) +### isLoggedIn() ---- +> **isLoggedIn**(): `boolean` -### isLoggedIn - -▸ **isLoggedIn**(): `boolean` +Defined in: [fusion-auth.service.ts:76](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L76) A function that returns whether the user is logged in. This returned value is non-observable. @@ -183,15 +229,13 @@ A function that returns whether the user is logged in. This returned value is no `boolean` -#### Defined in - -[lib/fusion-auth.service.ts:47](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L47) +*** ---- +### logout() -### logout +> **logout**(): `void` -▸ **logout**(): `void` +Defined in: [fusion-auth.service.ts:160](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L160) Initiates logout flow. @@ -199,15 +243,13 @@ Initiates logout flow. `void` -#### Defined in +*** -[lib/fusion-auth.service.ts:125](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L125) +### manageAccount() ---- +> **manageAccount**(): `void` -### manageAccount - -▸ **manageAccount**(): `void` +Defined in: [fusion-auth.service.ts:168](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L168) Redirects to [self service account management](https://fusionauth.io/docs/lifecycle/manage-users/account-management/) Self service account management is only available in FusionAuth paid plans. @@ -216,15 +258,13 @@ Self service account management is only available in FusionAuth paid plans. `void` -#### Defined in - -[lib/fusion-auth.service.ts:133](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L133) +*** ---- +### refreshToken() -### refreshToken +> **refreshToken**(): `Promise`\<`Response`\> -▸ **refreshToken**(): `Promise`\<`Response`\> +Defined in: [fusion-auth.service.ts:84](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L84) Refreshes the access token a single time. Automatic token refreshing can be enabled if the SDK is configured with `shouldAutoRefresh`. @@ -233,50 +273,46 @@ Automatic token refreshing can be enabled if the SDK is configured with `shouldA `Promise`\<`Response`\> -#### Defined in +*** -[lib/fusion-auth.service.ts:55](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L55) +### startLogin() ---- +> **startLogin**(`state?`): `void` -### startLogin - -▸ **startLogin**(`state?`): `void` +Defined in: [fusion-auth.service.ts:145](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L145) Initiates login flow. #### Parameters -| Name | Type | Description | -| :------- | :------- | :--------------------------------------------------------- | -| `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | +##### state? + +`string` + +Optional value to be echoed back to the SDK upon redirect. #### Returns `void` -#### Defined in - -[lib/fusion-auth.service.ts:110](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L110) +*** ---- +### startRegistration() -### startRegistration +> **startRegistration**(`state?`): `void` -▸ **startRegistration**(`state?`): `void` +Defined in: [fusion-auth.service.ts:153](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L153) Initiates register flow. #### Parameters -| Name | Type | Description | -| :------- | :------- | :--------------------------------------------------------- | -| `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | +##### state? -#### Returns +`string` -`void` +Optional value to be echoed back to the SDK upon redirect. -#### Defined in +#### Returns -[lib/fusion-auth.service.ts:118](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L118) +`void` diff --git a/packages/sdk-angular/docs/modules.md b/packages/sdk-angular/docs/globals.md similarity index 85% rename from packages/sdk-angular/docs/modules.md rename to packages/sdk-angular/docs/globals.md index 78fee8c..c257bfe 100644 --- a/packages/sdk-angular/docs/modules.md +++ b/packages/sdk-angular/docs/globals.md @@ -1,10 +1,10 @@ -[@fusionauth/angular-sdk](README.md) / Exports +[**@fusionauth/angular-sdk**](README.md) -# @fusionauth/angular-sdk +*** -## Table of contents +# @fusionauth/angular-sdk -### Classes +## Classes - [FusionAuthAccountButtonComponent](classes/FusionAuthAccountButtonComponent.md) - [FusionAuthLoginButtonComponent](classes/FusionAuthLoginButtonComponent.md) @@ -13,7 +13,7 @@ - [FusionAuthRegisterButtonComponent](classes/FusionAuthRegisterButtonComponent.md) - [FusionAuthService](classes/FusionAuthService.md) -### Interfaces +## Interfaces - [FusionAuthConfig](interfaces/FusionAuthConfig.md) - [UserInfo](interfaces/UserInfo.md) diff --git a/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md b/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md index 15f59eb..c66b542 100644 --- a/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md +++ b/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md @@ -1,220 +1,194 @@ -[@fusionauth/angular-sdk](../README.md) / [Exports](../modules.md) / FusionAuthConfig +[**@fusionauth/angular-sdk**](../README.md) + +*** + +[@fusionauth/angular-sdk](../globals.md) / FusionAuthConfig # Interface: FusionAuthConfig -Config for FusionAuth Angular SDK +Defined in: [types.ts:4](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L4) -## Table of contents - -### Properties - -- [autoRefreshSecondsBeforeExpiry](FusionAuthConfig.md#autorefreshsecondsbeforeexpiry) -- [clientId](FusionAuthConfig.md#clientid) -- [loginPath](FusionAuthConfig.md#loginpath) -- [logoutPath](FusionAuthConfig.md#logoutpath) -- [mePath](FusionAuthConfig.md#mepath) -- [onAutoRefreshFailure](FusionAuthConfig.md#onautorefreshfailure) -- [onRedirect](FusionAuthConfig.md#onredirect) -- [postLogoutRedirectUri](FusionAuthConfig.md#postlogoutredirecturi) -- [redirectUri](FusionAuthConfig.md#redirecturi) -- [registerPath](FusionAuthConfig.md#registerpath) -- [scope](FusionAuthConfig.md#scope) -- [serverUrl](FusionAuthConfig.md#serverurl) -- [shouldAutoRefresh](FusionAuthConfig.md#shouldautorefresh) -- [tokenRefreshPath](FusionAuthConfig.md#tokenrefreshpath) +Config for FusionAuth Angular SDK ## Properties -### autoRefreshSecondsBeforeExpiry +### autoRefreshSecondsBeforeExpiry? -• `Optional` **autoRefreshSecondsBeforeExpiry**: `number` +> `optional` **autoRefreshSecondsBeforeExpiry?**: `number` -The number of seconds before the access token expiry when the auto refresh functionality kicks in if enabled. Default is 10. - -#### Defined in +Defined in: [types.ts:38](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L38) -[lib/types.ts:38](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L38) +The number of seconds before the access token expiry when the auto refresh functionality kicks in if enabled. Default is 10. ---- +*** ### clientId -• **clientId**: `string` +> **clientId**: `string` + +Defined in: [types.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L13) The client id of the application. -#### Defined in +*** -[lib/types.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L13) +### dpopTokenStorage? ---- +> `optional` **dpopTokenStorage?**: `"localStorage"` \| `"memory"` -### loginPath +Defined in: [types.ts:86](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L86) -• `Optional` **loginPath**: `string` +Token storage location in DPoP mode. Only meaningful when `useDpop: true`. +Defaults to `'localStorage'`. -The path to the login endpoint. +*** + +### loginPath? -#### Defined in +> `optional` **loginPath?**: `string` -[lib/types.ts:53](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L53) +Defined in: [types.ts:53](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L53) ---- +The path to the login endpoint. -### logoutPath +*** -• `Optional` **logoutPath**: `string` +### logoutPath? -The path to the logout endpoint. +> `optional` **logoutPath?**: `string` -#### Defined in +Defined in: [types.ts:63](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L63) -[lib/types.ts:63](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L63) +The path to the logout endpoint. ---- +*** -### mePath +### mePath? -• `Optional` **mePath**: `string` +> `optional` **mePath?**: `string` -The path to the me endpoint. +Defined in: [types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L73) -#### Defined in +The path to the me endpoint. -[lib/types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L73) +*** ---- +### onAutoRefreshFailure? -### onAutoRefreshFailure +> `optional` **onAutoRefreshFailure?**: (`error`) => `void` -• `Optional` **onAutoRefreshFailure**: (`error`: `Error`) => `void` +Defined in: [types.ts:48](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L48) Callback to be invoked if a request to refresh the access token fails during autorefresh. -#### Type declaration - -▸ (`error`): `void` +#### Parameters -##### Parameters +##### error -| Name | Type | -| :------ | :------ | -| `error` | `Error` | +`Error` -##### Returns +#### Returns `void` -#### Defined in +*** -[lib/types.ts:48](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L48) +### onRedirect? ---- +> `optional` **onRedirect?**: (`state?`) => `void` -### onRedirect - -• `Optional` **onRedirect**: (`state?`: `string`) => `void` +Defined in: [types.ts:43](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L43) Callback function to be invoked with the `state` value upon redirect from login or register. -#### Type declaration - -▸ (`state?`): `void` +#### Parameters -##### Parameters +##### state? -| Name | Type | -| :------- | :------- | -| `state?` | `string` | +`string` -##### Returns +#### Returns `void` -#### Defined in +*** -[lib/types.ts:43](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L43) +### postLogoutRedirectUri? ---- +> `optional` **postLogoutRedirectUri?**: `string` -### postLogoutRedirectUri - -• `Optional` **postLogoutRedirectUri**: `string` +Defined in: [types.ts:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L23) The redirect URI for post-logout. Defaults the provided `redirectUri`. -#### Defined in - -[lib/types.ts:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L23) - ---- +*** ### redirectUri -• **redirectUri**: `string` +> **redirectUri**: `string` -The redirect URI of the application. +Defined in: [types.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L18) -#### Defined in +The redirect URI of the application. -[lib/types.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L18) +*** ---- +### registerPath? -### registerPath +> `optional` **registerPath?**: `string` -• `Optional` **registerPath**: `string` +Defined in: [types.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L58) The path to the register endpoint. -#### Defined in - -[lib/types.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L58) +*** ---- +### scope? -### scope +> `optional` **scope?**: `string` -• `Optional` **scope**: `string` +Defined in: [types.ts:28](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L28) The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not specified fusionauth will default this to `openid offline_access`. -#### Defined in - -[lib/types.ts:28](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L28) - ---- +*** ### serverUrl -• **serverUrl**: `string` +> **serverUrl**: `string` -The URL of the server that performs the token exchange. +Defined in: [types.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L8) -#### Defined in +The URL of the server that performs the token exchange. -[lib/types.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L8) +*** ---- +### shouldAutoRefresh? -### shouldAutoRefresh +> `optional` **shouldAutoRefresh?**: `boolean` -• `Optional` **shouldAutoRefresh**: `boolean` +Defined in: [types.ts:33](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L33) Enables automatic token refreshing. Defaults to false. -#### Defined in +*** -[lib/types.ts:33](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L33) +### tokenRefreshPath? ---- +> `optional` **tokenRefreshPath?**: `string` -### tokenRefreshPath - -• `Optional` **tokenRefreshPath**: `string` +Defined in: [types.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L68) The path to the token refresh endpoint. -#### Defined in +*** + +### useDpop? + +> `optional` **useDpop?**: `boolean` + +Defined in: [types.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L80) -[lib/types.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L68) +Opt-in to DPoP mode. When `true`, the SDK calls FusionAuth endpoints +directly and stores tokens in JavaScript-accessible storage instead of +relying on the Hosted Backend's HttpOnly cookies. Defaults to `false`. diff --git a/packages/sdk-angular/docs/interfaces/UserInfo.md b/packages/sdk-angular/docs/interfaces/UserInfo.md index 3eaac8f..41d9cee 100644 --- a/packages/sdk-angular/docs/interfaces/UserInfo.md +++ b/packages/sdk-angular/docs/interfaces/UserInfo.md @@ -1,173 +1,129 @@ -[@fusionauth/angular-sdk](../README.md) / [Exports](../modules.md) / UserInfo +[**@fusionauth/angular-sdk**](../README.md) -# Interface: UserInfo - -## Table of contents - -### Properties - -- [applicationId](UserInfo.md#applicationid) -- [birthdate](UserInfo.md#birthdate) -- [email](UserInfo.md#email) -- [email_verified](UserInfo.md#email_verified) -- [family_name](UserInfo.md#family_name) -- [given_name](UserInfo.md#given_name) -- [middle_name](UserInfo.md#middle_name) -- [name](UserInfo.md#name) -- [phone_number](UserInfo.md#phone_number) -- [picture](UserInfo.md#picture) -- [preferred_username](UserInfo.md#preferred_username) -- [roles](UserInfo.md#roles) -- [sid](UserInfo.md#sid) -- [sub](UserInfo.md#sub) -- [tid](UserInfo.md#tid) - -## Properties - -### applicationId - -• `Optional` **applicationId**: `string` - -#### Defined in - -[lib/types.ts:77](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L77) - ---- +*** -### birthdate +[@fusionauth/angular-sdk](../globals.md) / UserInfo -• `Optional` **birthdate**: `string` - -#### Defined in - -[lib/types.ts:78](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L78) - ---- - -### email - -• `Optional` **email**: `string` - -#### Defined in +# Interface: UserInfo -[lib/types.ts:79](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L79) +Defined in: [types.ts:89](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L89) ---- +## Properties -### email_verified +### applicationId? -• `Optional` **email_verified**: `boolean` +> `optional` **applicationId?**: `string` -#### Defined in +Defined in: [types.ts:90](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L90) -[lib/types.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L80) +*** ---- +### birthdate? -### family_name +> `optional` **birthdate?**: `string` -• `Optional` **family_name**: `string` +Defined in: [types.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L91) -#### Defined in +*** -[lib/types.ts:81](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L81) +### email? ---- +> `optional` **email?**: `string` -### given_name +Defined in: [types.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L92) -• `Optional` **given_name**: `string` +*** -#### Defined in +### email\_verified? -[lib/types.ts:82](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L82) +> `optional` **email\_verified?**: `boolean` ---- +Defined in: [types.ts:93](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L93) -### middle_name +*** -• `Optional` **middle_name**: `string` +### family\_name? -#### Defined in +> `optional` **family\_name?**: `string` -[lib/types.ts:83](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L83) +Defined in: [types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L94) ---- +*** -### name +### given\_name? -• `Optional` **name**: `string` +> `optional` **given\_name?**: `string` -#### Defined in +Defined in: [types.ts:95](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L95) -[lib/types.ts:84](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L84) +*** ---- +### middle\_name? -### phone_number +> `optional` **middle\_name?**: `string` -• `Optional` **phone_number**: `string` +Defined in: [types.ts:96](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L96) -#### Defined in +*** -[lib/types.ts:85](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L85) +### name? ---- +> `optional` **name?**: `string` -### picture +Defined in: [types.ts:97](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L97) -• `Optional` **picture**: `string` +*** -#### Defined in +### phone\_number? -[lib/types.ts:86](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L86) +> `optional` **phone\_number?**: `string` ---- +Defined in: [types.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L98) -### preferred_username +*** -• `Optional` **preferred_username**: `string` +### picture? -#### Defined in +> `optional` **picture?**: `string` -[lib/types.ts:87](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L87) +Defined in: [types.ts:99](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L99) ---- +*** -### roles +### preferred\_username? -• `Optional` **roles**: `any`[] +> `optional` **preferred\_username?**: `string` -#### Defined in +Defined in: [types.ts:100](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L100) -[lib/types.ts:88](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L88) +*** ---- +### roles? -### sid +> `optional` **roles?**: `any`[] -• `Optional` **sid**: `string` +Defined in: [types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L101) -#### Defined in +*** -[lib/types.ts:89](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L89) +### sid? ---- +> `optional` **sid?**: `string` -### sub +Defined in: [types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L102) -• `Optional` **sub**: `string` +*** -#### Defined in +### sub? -[lib/types.ts:90](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L90) +> `optional` **sub?**: `string` ---- +Defined in: [types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L103) -### tid +*** -• `Optional` **tid**: `string` +### tid? -#### Defined in +> `optional` **tid?**: `string` -[lib/types.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/80c01c9ccb450a2187bc0d2cc65fa8c9c38cfabe/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L91) +Defined in: [types.ts:104](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L104) diff --git a/packages/sdk-react/README.md b/packages/sdk-react/README.md index 4e4e2b3..44e7ba0 100644 --- a/packages/sdk-react/README.md +++ b/packages/sdk-react/README.md @@ -14,6 +14,7 @@ An SDK for using FusionAuth in React applications. - [Protecting content](#protecting-content) - [UI Components](#ui-components) - [DPoP Mode](#dpop-mode) + - [Resource Server Guidance](#resource-server-guidance) - [Known issues](#known-issues) - [Documentation](#documentation) - [Formatting](#formatting) @@ -260,6 +261,16 @@ const proof = await generateProof('https://api.example.com/data', 'GET', accessT // }); ``` +#### Resource Server Guidance + +If you're building a resource server that validates FusionAuth-issued DPoP tokens (this guidance applies regardless of which SDK, if any, the resource server itself uses): + +- This SDK does not implement `jti` replay prevention — tracking which proof JTIs have already been seen, and rejecting duplicates, is the resource server's responsibility. + - Single-instance deployments: an in-memory `Map` with TTL-based eviction is sufficient. + - Horizontally scaled deployments: a distributed store (e.g. Redis) is required, since replay state must be shared across instances. +- Validate the proof's `htu` claim against the request's actual URL. If the resource server sits behind a reverse proxy, ensure it's configured to trust the proxy and expose the public-facing URL (not an internal one) for this comparison. +- The `Authorization` header uses the `DPoP` scheme, not `Bearer` — resource servers must accept `Authorization: DPoP `. + ### Known Issues None. diff --git a/packages/sdk-react/docs/README.md b/packages/sdk-react/docs/README.md index 0d68dd0..5367218 100644 --- a/packages/sdk-react/docs/README.md +++ b/packages/sdk-react/docs/README.md @@ -15,6 +15,8 @@ An SDK for using FusionAuth in React applications. - [State Parameter](#state-parameter) - [Protecting content](#protecting-content) - [UI Components](#ui-components) + - [DPoP Mode](#dpop-mode) + - [Resource Server Guidance](#resource-server-guidance) - [Known issues](#known-issues) - [Documentation](#documentation) - [Formatting](#formatting) @@ -98,6 +100,7 @@ const config: FusionAuthProviderConfig = { shouldAutoFetchUserInfo: true, // Automatically fetch userInfo when logged in. Defaults to false. shouldAutoRefresh: true, // Enables automatic token refresh. Defaults to false. onRedirect: (state?: string) => { }, // Optional callback invoked upon redirect back from login or register. + // useDpop: true, // Opt-in to DPoP mode. See "DPoP Mode" below. Defaults to false. }; ReactDOM.createRoot(document.getElementById("my-app")).render( @@ -230,6 +233,46 @@ export const AccountPage = () => ( ); ``` +### DPoP Mode + +By default, the SDK calls a Hosted Backend that stores tokens in HttpOnly cookies (`useDpop: false`, the default). In DPoP mode, the SDK instead calls FusionAuth endpoints directly and binds tokens to a private key generated in the browser, per [RFC 9449](https://datatracker.ietf.org/doc/html/rfc9449). Enable it by setting `useDpop: true` on `FusionAuthProviderConfig`: + +```jsx +const config: FusionAuthProviderConfig = { + clientId: "", + redirectUri: "", + serverUrl: "", + useDpop: true, // Opt-in to DPoP mode. + dpopTokenStorage: 'localStorage', // 'localStorage' (default, persists across reloads) or 'memory'. +}; +``` + +When `useDpop: true`, `useFusionAuth()` additionally returns `dpopFetch`, `generateProof`, and `getAccessToken`. These are `undefined` when `useDpop` is `false` or not set. + +```jsx +const { dpopFetch, generateProof, getAccessToken } = useFusionAuth(); + +// Recommended — handles attaching DPoP headers (and nonce retries) automatically. +const response = await dpopFetch('https://api.example.com/data', { method: 'GET' }); + +// Advanced — for axios or other HTTP libraries that can't use dpopFetch. +const accessToken = getAccessToken(); +const proof = await generateProof('https://api.example.com/data', 'GET', accessToken); +// axios.get('https://api.example.com/data', { +// headers: { Authorization: `DPoP ${accessToken}`, DPoP: proof } +// }); +``` + +#### Resource Server Guidance + +If you're building a resource server that validates FusionAuth-issued DPoP tokens (this guidance applies regardless of which SDK, if any, the resource server itself uses): + +- This SDK does not implement `jti` replay prevention — tracking which proof JTIs have already been seen, and rejecting duplicates, is the resource server's responsibility. + - Single-instance deployments: an in-memory `Map` with TTL-based eviction is sufficient. + - Horizontally scaled deployments: a distributed store (e.g. Redis) is required, since replay state must be shared across instances. +- Validate the proof's `htu` claim against the request's actual URL. If the resource server sits behind a reverse proxy, ensure it's configured to trust the proxy and expose the public-facing URL (not an internal one) for this comparison. +- The `Authorization` header uses the `DPoP` scheme, not `Bearer` — resource servers must accept `Authorization: DPoP `. + ### Known Issues None. diff --git a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md index 9cbbf2e..258c71b 100644 --- a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md +++ b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md @@ -14,6 +14,7 @@ Config for FusionAuthProvider - [authParams](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#authparams) - [autoRefreshSecondsBeforeExpiry](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#autorefreshsecondsbeforeexpiry) - [clientId](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#clientid) +- [dpopTokenStorage](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#dpoptokenstorage) - [loginPath](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#loginpath) - [logoutPath](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#logoutpath) - [mePath](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#mepath) @@ -28,6 +29,7 @@ Config for FusionAuthProvider - [shouldAutoFetchUserInfo](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#shouldautofetchuserinfo) - [shouldAutoRefresh](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#shouldautorefresh) - [tokenRefreshPath](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#tokenrefreshpath) +- [useDpop](providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md#usedpop) ## Properties @@ -40,21 +42,21 @@ Only set this if you are hosting server that uses a custom name for the 'app.at_ #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L98) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L98) ---- +___ ### authParams -• `Optional` **authParams**: \{ `[key: string]`: `any`; }[] +• `Optional` **authParams**: \{ `[key: string]`: `any`; }[] Additional params passed to loginPath typically `/app/login/`, which redirects to `/oauth2/authorize`. Example of this might be loginParams = [{idp_hint:'44449786-3dff-42a6-aac6-1f1ceecb6c46'}] or any params found at https://fusionauth.io/docs/lifecycle/authenticate-users/oauth/endpoints #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:30](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L30) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:30](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L30) ---- +___ ### autoRefreshSecondsBeforeExpiry @@ -64,9 +66,9 @@ The number of seconds before the access token expiry when the auto refresh funct #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:50](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L50) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:50](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L50) ---- +___ ### clientId @@ -76,9 +78,22 @@ The client id of the application. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L15) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L15) ---- +___ + +### dpopTokenStorage + +• `Optional` **dpopTokenStorage**: ``"localStorage"`` \| ``"memory"`` + +Token storage location in DPoP mode. Only meaningful when `useDpop: true`. +Defaults to `'localStorage'`. + +#### Defined in + +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:111](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L111) + +___ ### loginPath @@ -88,9 +103,9 @@ The path to the login endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L65) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L65) ---- +___ ### logoutPath @@ -100,9 +115,9 @@ The path to the logout endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:75](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L75) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:75](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L75) ---- +___ ### mePath @@ -112,9 +127,9 @@ The path to the me endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L92) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L92) ---- +___ ### nextCookieAdapter @@ -134,9 +149,9 @@ See docs for [configuration with nextjs](https://github.com/FusionAuth/fusionaut #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:87](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L87) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:87](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L87) ---- +___ ### onAutoRefreshFailure @@ -150,7 +165,7 @@ Callback to be invoked if a request to refresh the access token fails during aut ##### Parameters -| Name | Type | +| Name | Type | | :------ | :------ | | `error` | `Error` | @@ -160,9 +175,9 @@ Callback to be invoked if a request to refresh the access token fails during aut #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L60) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L60) ---- +___ ### onRedirect @@ -176,8 +191,8 @@ Callback function to be invoked with the `state` value upon redirect from login ##### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `state?` | `string` | ##### Returns @@ -186,9 +201,9 @@ Callback function to be invoked with the `state` value upon redirect from login #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:55](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L55) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:55](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L55) ---- +___ ### postLogoutRedirectUri @@ -198,9 +213,9 @@ The redirect URI for post-logout. Defaults the provided `redirectUri`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L35) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L35) ---- +___ ### redirectUri @@ -210,9 +225,9 @@ The redirect URI of the application. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:20](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L20) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:20](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L20) ---- +___ ### registerPath @@ -222,9 +237,9 @@ The path to the register endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L70) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L70) ---- +___ ### scope @@ -234,9 +249,9 @@ The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not sp #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L25) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L25) ---- +___ ### serverUrl @@ -246,9 +261,9 @@ The URL of the server that performs the token exchange. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L10) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L10) ---- +___ ### shouldAutoFetchUserInfo @@ -258,9 +273,9 @@ Enables the SDK to automatically handle fetching user info when logged in. Defau #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:45](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L45) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:45](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L45) ---- +___ ### shouldAutoRefresh @@ -270,9 +285,9 @@ Enables automatic token refreshing. Defaults to false. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:40](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L40) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:40](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L40) ---- +___ ### tokenRefreshPath @@ -282,4 +297,18 @@ The path to the token refresh endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L80) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L80) + +___ + +### useDpop + +• `Optional` **useDpop**: `boolean` + +Opt-in to DPoP mode. When `true`, the SDK calls FusionAuth endpoints +directly and stores tokens in JavaScript-accessible storage instead of +relying on the Hosted Backend's HttpOnly cookies. Defaults to `false`. + +#### Defined in + +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:105](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L105) diff --git a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md index 8ed7bb9..518188a 100644 --- a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md +++ b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md @@ -8,16 +8,19 @@ The context provided by FusionAuth React SDK ## Type parameters -| Name | Type | -| :--- | :--------- | -| `T` | `UserInfo` | +| Name | Type | +| :------ | :------ | +| `T` | `UserInfo` | ## Table of contents ### Properties +- [dpopFetch](providers_FusionAuthProviderContext.FusionAuthProviderContext.md#dpopfetch) - [error](providers_FusionAuthProviderContext.FusionAuthProviderContext.md#error) - [fetchUserInfo](providers_FusionAuthProviderContext.FusionAuthProviderContext.md#fetchuserinfo) +- [generateProof](providers_FusionAuthProviderContext.FusionAuthProviderContext.md#generateproof) +- [getAccessToken](providers_FusionAuthProviderContext.FusionAuthProviderContext.md#getaccesstoken) - [initAutoRefresh](providers_FusionAuthProviderContext.FusionAuthProviderContext.md#initautorefresh) - [isFetchingUserInfo](providers_FusionAuthProviderContext.FusionAuthProviderContext.md#isfetchinguserinfo) - [isLoggedIn](providers_FusionAuthProviderContext.FusionAuthProviderContext.md#isloggedin) @@ -30,17 +33,45 @@ The context provided by FusionAuth React SDK ## Properties +### dpopFetch + +• `Optional` **dpopFetch**: (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> + +Fetch wrapper that automatically attaches DPoP proof headers. +Present only when `useDpop: true`. + +#### Type declaration + +▸ (`input`, `init?`): `Promise`\<`Response`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | `RequestInfo` \| `URL` | +| `init?` | `RequestInit` | + +##### Returns + +`Promise`\<`Response`\> + +#### Defined in + +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L70) + +___ + ### error -• **error**: `null` \| `Error` +• **error**: ``null`` \| `Error` Error occurred while fetching userInfo. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L29) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L29) ---- +___ ### fetchUserInfo @@ -59,9 +90,61 @@ This is handled automatically if the SDK is configured with `shouldAutoFetchUser #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L19) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L19) + +___ + +### generateProof + +• `Optional` **generateProof**: (`htu`: `string`, `htm`: `string`, `accessToken?`: `string`, `nonce?`: `string`) => `Promise`\<`string`\> + +Returns a signed DPoP proof JWT for use with axios or other +HTTP libraries. Present only when `useDpop: true`. + +#### Type declaration + +▸ (`htu`, `htm`, `accessToken?`, `nonce?`): `Promise`\<`string`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `htu` | `string` | +| `htm` | `string` | +| `accessToken?` | `string` | +| `nonce?` | `string` | + +##### Returns + +`Promise`\<`string`\> + +#### Defined in + +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:79](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L79) + +___ + +### getAccessToken + +• `Optional` **getAccessToken**: () => ``null`` \| `string` + +Returns the stored DPoP access token, or `null` if not logged in. +Throws a descriptive error when `useDpop: false`. +Present only when `useDpop: true`. + +#### Type declaration + +▸ (): ``null`` \| `string` + +##### Returns + +``null`` \| `string` + +#### Defined in + +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L91) ---- +___ ### initAutoRefresh @@ -80,9 +163,9 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:64](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L64) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:64](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L64) ---- +___ ### isFetchingUserInfo @@ -92,9 +175,9 @@ Indicates that the fetchUserInfo call is unresolved. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L24) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L24) ---- +___ ### isLoggedIn @@ -104,9 +187,9 @@ Whether the user is logged in. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L8) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L8) ---- +___ ### manageAccount @@ -125,9 +208,9 @@ Self service account management is only available in FusionAuth paid plans. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:52](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L52) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:52](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L52) ---- +___ ### refreshToken @@ -146,9 +229,9 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L58) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L58) ---- +___ ### startLogin @@ -162,8 +245,8 @@ Initiates login flow. ##### Parameters -| Name | Type | Description | -| :------- | :------- | :--------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | ##### Returns @@ -172,9 +255,9 @@ Initiates login flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L35) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L35) ---- +___ ### startLogout @@ -192,9 +275,9 @@ Initiates logout flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:46](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L46) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:46](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L46) ---- +___ ### startRegister @@ -208,8 +291,8 @@ Initiates register flow. ##### Parameters -| Name | Type | Description | -| :------- | :------- | :--------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | ##### Returns @@ -218,16 +301,16 @@ Initiates register flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:41](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L41) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:41](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L41) ---- +___ ### userInfo -• **userInfo**: `null` \| `T` +• **userInfo**: ``null`` \| `T` Data fetched from the configured 'me' endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L13) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L13) diff --git a/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md b/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md index f84520b..a32cd97 100644 --- a/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md +++ b/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md @@ -17,15 +17,15 @@ #### Type parameters -| Name | Type | -| :--- | :--------- | -| `T` | `UserInfo` | +| Name | Type | +| :------ | :------ | +| `T` | `UserInfo` | #### Parameters -| Name | Type | -| :------ | :----------------------------------------------------------------------------------------------------------------------------------------- | -| `props` | \{ `children?`: `ReactNode` } & [`FusionAuthProviderConfig`](../interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md) | +| Name | Type | +| :------ | :------ | +| `props` | \{ `children?`: `ReactNode` } & [`FusionAuthProviderConfig`](../interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md) | #### Returns @@ -33,9 +33,9 @@ #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:21](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L21) +[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L23) ---- +___ ### useFusionAuth @@ -45,9 +45,9 @@ A hook that returns `FusionAuthProviderContext` #### Type parameters -| Name | Type | -| :--- | :--------- | -| `T` | `UserInfo` | +| Name | Type | +| :------ | :------ | +| `T` | `UserInfo` | #### Returns @@ -55,4 +55,4 @@ A hook that returns `FusionAuthProviderContext` #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:122](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L122) +[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:155](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L155) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md index 4ba81bf..9b325fd 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md @@ -18,8 +18,8 @@ Calls the `startLogin` method from `FusionAuthProviderContext`. #### Parameters -| Name | Type | -| :------ | :--------------------------- | +| Name | Type | +| :------ | :------ | | `props` | `FusionAuthLoginButtonProps` | #### Returns @@ -28,4 +28,4 @@ Calls the `startLogin` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx#L16) +[packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx#L16) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md index 67e103c..be1cc64 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md @@ -18,8 +18,8 @@ Calls the `startLogout` method from `FusionAuthProviderContext`. #### Parameters -| Name | Type | -| :------ | :---------------------------- | +| Name | Type | +| :------ | :------ | | `props` | `FusionAuthLogoutButtonProps` | #### Returns @@ -28,4 +28,4 @@ Calls the `startLogout` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx#L13) +[packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx#L13) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md index 30a2074..1ab69fb 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md @@ -18,8 +18,8 @@ Calls the `startRegister` method from `FusionAuthProviderContext`. #### Parameters -| Name | Type | -| :------ | :------------------------------ | +| Name | Type | +| :------ | :------ | | `props` | `FusionAuthRegisterButtonProps` | #### Returns @@ -28,4 +28,4 @@ Calls the `startRegister` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx#L15) +[packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx#L15) diff --git a/packages/sdk-react/docs/modules/ui_RequireAuth.md b/packages/sdk-react/docs/modules/ui_RequireAuth.md index 50286a5..1c08263 100644 --- a/packages/sdk-react/docs/modules/ui_RequireAuth.md +++ b/packages/sdk-react/docs/modules/ui_RequireAuth.md @@ -18,8 +18,8 @@ Only renders children when user is authenticated. #### Parameters -| Name | Type | -| :------ | :----------------- | +| Name | Type | +| :------ | :------ | | `props` | `RequireAuthProps` | #### Returns @@ -28,4 +28,4 @@ Only renders children when user is authenticated. #### Defined in -[packages/sdk-react/src/components/ui/RequireAuth/index.tsx:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/ui/RequireAuth/index.tsx#L10) +[packages/sdk-react/src/components/ui/RequireAuth/index.tsx:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/RequireAuth/index.tsx#L10) diff --git a/packages/sdk-react/docs/modules/ui_Unauthenticated.md b/packages/sdk-react/docs/modules/ui_Unauthenticated.md index 577dbf5..d402054 100644 --- a/packages/sdk-react/docs/modules/ui_Unauthenticated.md +++ b/packages/sdk-react/docs/modules/ui_Unauthenticated.md @@ -18,9 +18,9 @@ Only renders children when user is unauthenticated. #### Parameters -| Name | Type | -| :---------------- | :---------- | -| `props` | `Object` | +| Name | Type | +| :------ | :------ | +| `props` | `Object` | | `props.children?` | `ReactNode` | #### Returns @@ -29,4 +29,4 @@ Only renders children when user is unauthenticated. #### Defined in -[packages/sdk-react/src/components/ui/Unauthenticated/index.tsx:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/63efa2d5360c2b7e1392ffa730dac8f5a0bc8e19/packages/sdk-react/src/components/ui/Unauthenticated/index.tsx#L5) +[packages/sdk-react/src/components/ui/Unauthenticated/index.tsx:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/Unauthenticated/index.tsx#L5) diff --git a/packages/sdk-vue/README.md b/packages/sdk-vue/README.md index ae8333d..1e69a09 100644 --- a/packages/sdk-vue/README.md +++ b/packages/sdk-vue/README.md @@ -12,6 +12,7 @@ An SDK for using FusionAuth in Vue applications. - [useFusionAuth Composable](#usefusionauth-composable) - [State parameter](#state-parameter) - [DPoP Mode](#dpop-mode) + - [Resource Server Guidance](#resource-server-guidance) - [UI Components](#ui-components) - [Protecting Content](#protecting-content) - [Pre-built buttons](#pre-built-buttons) @@ -236,6 +237,16 @@ const config: FusionAuthConfig = { } ``` +##### Resource Server Guidance + +If you're building a resource server that validates FusionAuth-issued DPoP tokens (this guidance applies regardless of which SDK, if any, the resource server itself uses): + +- This SDK does not implement `jti` replay prevention — tracking which proof JTIs have already been seen, and rejecting duplicates, is the resource server's responsibility. + - Single-instance deployments: an in-memory `Map` with TTL-based eviction is sufficient. + - Horizontally scaled deployments: a distributed store (e.g. Redis) is required, since replay state must be shared across instances. +- Validate the proof's `htu` claim against the request's actual URL. If the resource server sits behind a reverse proxy, ensure it's configured to trust the proxy and expose the public-facing URL (not an internal one) for this comparison. +- The `Authorization` header uses the `DPoP` scheme, not `Bearer` — resource servers must accept `Authorization: DPoP `. + ### UI Components #### Protecting Content diff --git a/packages/sdk-vue/docs/README.md b/packages/sdk-vue/docs/README.md index b9f215c..5da1acf 100644 --- a/packages/sdk-vue/docs/README.md +++ b/packages/sdk-vue/docs/README.md @@ -6,16 +6,18 @@ An SDK for using FusionAuth in Vue applications. - [Overview](#overview) - [Getting Started](#getting-started) -- [Installation](#installation) + - [Quickstart](#quickstart) + - [Installation](#installation) - [Usage](#usage) - [Configuring the SDK](#configuring-the-sdk) - [Configuring with Nuxt](#configuring-with-nuxt) - [useFusionAuth Composable](#usefusionauth-composable) - [State parameter](#state-parameter) + - [DPoP Mode](#dpop-mode) + - [Resource Server Guidance](#resource-server-guidance) - [UI Components](#ui-components) - [Protecting Content](#protecting-content) - [Pre-built buttons](#pre-built-buttons) -- [Quickstart](#quickstart) - [Documentation](#documentation) - [Known Issues](#known-issues) - [Releases](#releases) @@ -63,6 +65,12 @@ compliant identity server. ## Getting Started +If you are new to Vue development, you may want to start with the Quickstart guide. If you are already familiar with Vue development, skip to the Installation section. + +### Quickstart + +See the [FusionAuth Vue Quickstart](https://fusionauth.io/docs/quickstarts/quickstart-javascript-vue-web) for a full tutorial on using FusionAuth and Vue. + ### Installation NPM: @@ -94,6 +102,7 @@ const config: FusionAuthConfig = { shouldAutoFetchUserInfo: true, // Automatically fetch userInfo when logged in. Defaults to false. shouldAutoRefresh: true, // Enables automatic token refresh. Defaults to false. onRedirect: (state?: string) => { }, // Optional callback invoked upon redirect back from login or register. + // useDpop: true, // Opt-in to DPoP mode. See "DPoP Mode" below. Defaults to false. } const app = createApp(App); @@ -188,6 +197,58 @@ const welcomeMessage = computed(() => { The `login` and `register` functions accept an optional string parameter: `state`, which will be passed back to the optional `onRedirect` callback specified on your `FusionAuthConfig`. Though you may pass any value you would like for the state parameter, it is often used to indicate which page the user was on before redirecting to login or registration, so that the user can be returned to that location after a successful authentication. +#### DPoP Mode + +By default, the SDK calls a Hosted Backend that stores tokens in HttpOnly cookies (`useDpop: false`, the default). In DPoP mode, the SDK instead calls FusionAuth endpoints directly and binds tokens to a private key generated in the browser. Enable it by setting `useDpop: true` on `FusionAuthConfig`: + +```typescript +const config: FusionAuthConfig = { + clientId: "", + redirectUri: "", + serverUrl: "", + useDpop: true, // Opt-in to DPoP mode. + dpopTokenStorage: 'localStorage', // 'localStorage' (default, persists across reloads) or 'memory'. +} +``` + +When `useDpop: true`, `useFusionAuth()` additionally returns `dpopFetch`, `generateProof`, and `getAccessToken`. These are `undefined` when `useDpop` is `false` or not set. + +```html + +``` + +In DPoP mode, the login/register redirect round trip finishes asynchronously (there's no Hosted Backend to set cookies before the app reloads). `onRedirect` fires only after `isLoggedIn` and tokens are fully updated, so it's a reliable place to hook in post-login navigation: + +```typescript +const config: FusionAuthConfig = { + // ... + useDpop: true, + onRedirect: () => router.push('/account'), +} +``` + +##### Resource Server Guidance + +If you're building a resource server that validates FusionAuth-issued DPoP tokens (this guidance applies regardless of which SDK, if any, the resource server itself uses): + +- This SDK does not implement `jti` replay prevention — tracking which proof JTIs have already been seen, and rejecting duplicates, is the resource server's responsibility. + - Single-instance deployments: an in-memory `Map` with TTL-based eviction is sufficient. + - Horizontally scaled deployments: a distributed store (e.g. Redis) is required, since replay state must be shared across instances. +- Validate the proof's `htu` claim against the request's actual URL. If the resource server sits behind a reverse proxy, ensure it's configured to trust the proxy and expose the public-facing URL (not an internal one) for this comparison. +- The `Authorization` header uses the `DPoP` scheme, not `Bearer` — resource servers must accept `Authorization: DPoP `. + ### UI Components #### Protecting Content @@ -232,10 +293,6 @@ is. With the CSS variables, you can customize the buttons to match your app’s style. -## Quickstart - -See the [FusionAuth Vue Quickstart](https://fusionauth.io/docs/quickstarts/quickstart-javascript-vue-web) for a full tutorial on using FusionAuth and Vue. - ## Documentation [Full library documentation](https://github.com/FusionAuth/fusionauth-javascript-sdk/tree/main/packages/sdk-vue/docs) diff --git a/packages/sdk-vue/docs/interfaces/FusionAuth.md b/packages/sdk-vue/docs/interfaces/FusionAuth.md index 488d031..26c30e9 100644 --- a/packages/sdk-vue/docs/interfaces/FusionAuth.md +++ b/packages/sdk-vue/docs/interfaces/FusionAuth.md @@ -6,15 +6,18 @@ FusionAuth object provided at app-level by FusionAuthVuePlugin ## Type parameters -| Name | Type | -| :--- | :------------------------ | -| `T` | [`UserInfo`](UserInfo.md) | +| Name | Type | +| :------ | :------ | +| `T` | [`UserInfo`](UserInfo.md) | ## Table of contents ### Properties +- [dpopFetch](FusionAuth.md#dpopfetch) - [error](FusionAuth.md#error) +- [generateProof](FusionAuth.md#generateproof) +- [getAccessToken](FusionAuth.md#getaccesstoken) - [getUserInfo](FusionAuth.md#getuserinfo) - [initAutoRefresh](FusionAuth.md#initautorefresh) - [isGettingUserInfo](FusionAuth.md#isgettinguserinfo) @@ -28,17 +31,97 @@ FusionAuth object provided at app-level by FusionAuthVuePlugin ## Properties +### dpopFetch + +• `Optional` **dpopFetch**: (`input`: `RequestInfo` \| `URL`, `init?`: `RequestInit`) => `Promise`\<`Response`\> + +Fetch wrapper that automatically attaches DPoP proof headers. +Present only when `useDpop: true`. + +#### Type declaration + +▸ (`input`, `init?`): `Promise`\<`Response`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `input` | `RequestInfo` \| `URL` | +| `init?` | `RequestInit` | + +##### Returns + +`Promise`\<`Response`\> + +#### Defined in + +[packages/sdk-vue/src/types.ts:188](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L188) + +___ + ### error -• **error**: `Ref`\<`null` \| `Error`\> +• **error**: `Ref`\<``null`` \| `Error`, ``null`` \| `Error`\> Error occurred within getUserInfo. #### Defined in -[src/types.ts:134](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L134) +[packages/sdk-vue/src/types.ts:147](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L147) + +___ + +### generateProof + +• `Optional` **generateProof**: (`htu`: `string`, `htm`: `string`, `accessToken?`: `string`, `nonce?`: `string`) => `Promise`\<`string`\> + +Returns a signed DPoP proof JWT for use with axios or other +HTTP libraries. Present only when `useDpop: true`. + +#### Type declaration + +▸ (`htu`, `htm`, `accessToken?`, `nonce?`): `Promise`\<`string`\> + +##### Parameters + +| Name | Type | +| :------ | :------ | +| `htu` | `string` | +| `htm` | `string` | +| `accessToken?` | `string` | +| `nonce?` | `string` | + +##### Returns + +`Promise`\<`string`\> + +#### Defined in + +[packages/sdk-vue/src/types.ts:197](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L197) + +___ + +### getAccessToken + +• `Optional` **getAccessToken**: () => ``null`` \| `string` + +Returns the stored DPoP access token, or `null` if not logged in. +Throws a descriptive error when `useDpop: false`. +Present only when `useDpop: true`. + +#### Type declaration + +▸ (): ``null`` \| `string` + +##### Returns + +``null`` \| `string` + +#### Defined in + +[packages/sdk-vue/src/types.ts:209](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L209) ---- +___ ### getUserInfo @@ -57,9 +140,9 @@ Internally updates `isFetchingUser` and `userInfo` refs, as well as `error` if t #### Defined in -[src/types.ts:119](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L119) +[packages/sdk-vue/src/types.ts:132](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L132) ---- +___ ### initAutoRefresh @@ -78,33 +161,33 @@ Refresh is scheduled to happen at the configured `autoRefreshSecondsBeforeExpiry #### Defined in -[src/types.ts:169](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L169) +[packages/sdk-vue/src/types.ts:182](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L182) ---- +___ ### isGettingUserInfo -• **isGettingUserInfo**: `Ref`\<`boolean`\> +• **isGettingUserInfo**: `Ref`\<`boolean`, `boolean`\> Indicates that the getUserInfo call is unresolved. #### Defined in -[src/types.ts:129](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L129) +[packages/sdk-vue/src/types.ts:142](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L142) ---- +___ ### isLoggedIn -• **isLoggedIn**: `Ref`\<`boolean`\> +• **isLoggedIn**: `Ref`\<`boolean`, `boolean`\> Whether the user is logged in. #### Defined in -[src/types.ts:112](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L112) +[packages/sdk-vue/src/types.ts:125](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L125) ---- +___ ### login @@ -118,8 +201,8 @@ Initiates login flow. ##### Parameters -| Name | Type | Description | -| :------- | :------- | :--------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | ##### Returns @@ -128,9 +211,9 @@ Initiates login flow. #### Defined in -[src/types.ts:140](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L140) +[packages/sdk-vue/src/types.ts:153](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L153) ---- +___ ### logout @@ -148,9 +231,9 @@ Initiates a logout. #### Defined in -[src/types.ts:151](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L151) +[packages/sdk-vue/src/types.ts:164](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L164) ---- +___ ### manageAccount @@ -169,9 +252,9 @@ Self service account management is only available in FusionAuth paid plans. #### Defined in -[src/types.ts:157](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L157) +[packages/sdk-vue/src/types.ts:170](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L170) ---- +___ ### refreshToken @@ -190,9 +273,9 @@ Token refreshing is handled automatically if configured with `shouldAutoRefresh` #### Defined in -[src/types.ts:163](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L163) +[packages/sdk-vue/src/types.ts:176](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L176) ---- +___ ### register @@ -206,8 +289,8 @@ Initiates register flow. ##### Parameters -| Name | Type | Description | -| :------- | :------- | :--------------------------------------------------------- | +| Name | Type | Description | +| :------ | :------ | :------ | | `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | ##### Returns @@ -216,16 +299,16 @@ Initiates register flow. #### Defined in -[src/types.ts:146](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L146) +[packages/sdk-vue/src/types.ts:159](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L159) ---- +___ ### userInfo -• **userInfo**: `Ref`\<`null` \| `T`\> +• **userInfo**: `Ref`\<``null`` \| `T`, ``null`` \| `T`\> Data fetched from the configured 'me' endpoint. #### Defined in -[src/types.ts:124](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L124) +[packages/sdk-vue/src/types.ts:137](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L137) diff --git a/packages/sdk-vue/docs/interfaces/FusionAuthConfig.md b/packages/sdk-vue/docs/interfaces/FusionAuthConfig.md index f712b9d..0a6383f 100644 --- a/packages/sdk-vue/docs/interfaces/FusionAuthConfig.md +++ b/packages/sdk-vue/docs/interfaces/FusionAuthConfig.md @@ -10,6 +10,7 @@ Config for the FusionAuth Vue SDK - [autoRefreshSecondsBeforeExpiry](FusionAuthConfig.md#autorefreshsecondsbeforeexpiry) - [clientId](FusionAuthConfig.md#clientid) +- [dpopTokenStorage](FusionAuthConfig.md#dpoptokenstorage) - [loginPath](FusionAuthConfig.md#loginpath) - [logoutPath](FusionAuthConfig.md#logoutpath) - [mePath](FusionAuthConfig.md#mepath) @@ -24,6 +25,7 @@ Config for the FusionAuth Vue SDK - [shouldAutoFetchUserInfo](FusionAuthConfig.md#shouldautofetchuserinfo) - [shouldAutoRefresh](FusionAuthConfig.md#shouldautorefresh) - [tokenRefreshPath](FusionAuthConfig.md#tokenrefreshpath) +- [useDpop](FusionAuthConfig.md#usedpop) ## Properties @@ -35,9 +37,9 @@ The number of seconds before the access token expiry when the auto refresh funct #### Defined in -[src/types.ts:44](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L44) +[packages/sdk-vue/src/types.ts:44](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L44) ---- +___ ### clientId @@ -47,9 +49,22 @@ The client id of the application. #### Defined in -[src/types.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L15) +[packages/sdk-vue/src/types.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L15) ---- +___ + +### dpopTokenStorage + +• `Optional` **dpopTokenStorage**: ``"localStorage"`` \| ``"memory"`` + +Token storage location in DPoP mode. Only meaningful when `useDpop: true`. +Defaults to `'localStorage'`. + +#### Defined in + +[packages/sdk-vue/src/types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L94) + +___ ### loginPath @@ -59,9 +74,9 @@ The path to the login endpoint. #### Defined in -[src/types.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L65) +[packages/sdk-vue/src/types.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L65) ---- +___ ### logoutPath @@ -71,9 +86,9 @@ The path to the logout endpoint. #### Defined in -[src/types.ts:69](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L69) +[packages/sdk-vue/src/types.ts:69](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L69) ---- +___ ### mePath @@ -83,13 +98,13 @@ The path to the me endpoint. #### Defined in -[src/types.ts:81](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L81) +[packages/sdk-vue/src/types.ts:81](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L81) ---- +___ ### nuxtUseCookie -• `Optional` **nuxtUseCookie**: \(`name`: `string`, `_opts?`: `CookieOptions`\<`T`\> & \{ `readonly?`: `false` }) => `CookieRef`\<`T`\>\(`name`: `string`, `_opts`: `CookieOptions`\<`T`\> & \{ `readonly`: `true` }) => `Readonly`\<`CookieRef`\<`T`\>\> +• `Optional` **nuxtUseCookie**: \(`name`: `string`, `_opts?`: `CookieOptions`\<`T`\> & \{ `readonly?`: ``false`` }) => `CookieRef`\<`T`\>\(`name`: `string`, `_opts`: `CookieOptions`\<`T`\> & \{ `readonly`: ``true`` }) => `Readonly`\<`CookieRef`\<`T`\>\> Pass in `useCookie` from nuxt/app [useCookie](https://nuxt.com/docs/api/composables/use-cookie). This is needed for the Vue SDK to support Nuxt/SSR. @@ -100,16 +115,16 @@ This is needed for the Vue SDK to support Nuxt/SSR. ##### Type parameters -| Name | Type | -| :--- | :-------------------------------- | -| `T` | `undefined` \| `null` \| `string` | +| Name | Type | +| :------ | :------ | +| `T` | `undefined` \| ``null`` \| `string` | ##### Parameters -| Name | Type | -| :------- | :------------------------------------------------- | -| `name` | `string` | -| `_opts?` | `CookieOptions`\<`T`\> & \{ `readonly?`: `false` } | +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `_opts?` | `CookieOptions`\<`T`\> & \{ `readonly?`: ``false`` } | ##### Returns @@ -119,16 +134,16 @@ This is needed for the Vue SDK to support Nuxt/SSR. ##### Type parameters -| Name | Type | -| :--- | :-------------------------------- | -| `T` | `undefined` \| `null` \| `string` | +| Name | Type | +| :------ | :------ | +| `T` | `undefined` \| ``null`` \| `string` | ##### Parameters -| Name | Type | -| :------ | :----------------------------------------------- | -| `name` | `string` | -| `_opts` | `CookieOptions`\<`T`\> & \{ `readonly`: `true` } | +| Name | Type | +| :------ | :------ | +| `name` | `string` | +| `_opts` | `CookieOptions`\<`T`\> & \{ `readonly`: ``true`` } | ##### Returns @@ -136,9 +151,9 @@ This is needed for the Vue SDK to support Nuxt/SSR. #### Defined in -[src/types.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L60) +[packages/sdk-vue/src/types.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L60) ---- +___ ### onAutoRefreshFailure @@ -152,7 +167,7 @@ Callback to be invoked if a request to refresh the access token fails during aut ##### Parameters -| Name | Type | +| Name | Type | | :------ | :------ | | `error` | `Error` | @@ -162,9 +177,9 @@ Callback to be invoked if a request to refresh the access token fails during aut #### Defined in -[src/types.ts:54](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L54) +[packages/sdk-vue/src/types.ts:54](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L54) ---- +___ ### onRedirect @@ -178,8 +193,8 @@ Callback function to be invoked with the `state` value upon redirect from login ##### Parameters -| Name | Type | -| :------- | :------- | +| Name | Type | +| :------ | :------ | | `state?` | `string` | ##### Returns @@ -188,9 +203,9 @@ Callback function to be invoked with the `state` value upon redirect from login #### Defined in -[src/types.ts:49](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L49) +[packages/sdk-vue/src/types.ts:49](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L49) ---- +___ ### postLogoutRedirectUri @@ -200,9 +215,9 @@ The redirect URI for post-logout. Defaults the provided `redirectUri`. #### Defined in -[src/types.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L24) +[packages/sdk-vue/src/types.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L24) ---- +___ ### redirectUri @@ -212,9 +227,9 @@ The redirect URI of the application. #### Defined in -[src/types.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L19) +[packages/sdk-vue/src/types.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L19) ---- +___ ### registerPath @@ -224,9 +239,9 @@ The path to the register endpoint. #### Defined in -[src/types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L73) +[packages/sdk-vue/src/types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L73) ---- +___ ### scope @@ -236,9 +251,9 @@ The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not sp #### Defined in -[src/types.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L29) +[packages/sdk-vue/src/types.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L29) ---- +___ ### serverUrl @@ -248,9 +263,9 @@ The URL of the FusionAuth server. #### Defined in -[src/types.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L11) +[packages/sdk-vue/src/types.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L11) ---- +___ ### shouldAutoFetchUserInfo @@ -260,9 +275,9 @@ Enables the SDK to automatically handle fetching user info when logged in. Defau #### Defined in -[src/types.ts:39](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L39) +[packages/sdk-vue/src/types.ts:39](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L39) ---- +___ ### shouldAutoRefresh @@ -272,9 +287,9 @@ Enables automatic token refreshing. Defaults to false. #### Defined in -[src/types.ts:34](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L34) +[packages/sdk-vue/src/types.ts:34](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L34) ---- +___ ### tokenRefreshPath @@ -284,4 +299,18 @@ The path to the token refresh endpoint. #### Defined in -[src/types.ts:77](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L77) +[packages/sdk-vue/src/types.ts:77](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L77) + +___ + +### useDpop + +• `Optional` **useDpop**: `boolean` + +Opt-in to DPoP mode. When `true`, the SDK calls FusionAuth endpoints +directly and stores tokens in JavaScript-accessible storage instead of +relying on the Hosted Backend's HttpOnly cookies. Defaults to `false`. + +#### Defined in + +[packages/sdk-vue/src/types.ts:88](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L88) diff --git a/packages/sdk-vue/docs/interfaces/UserInfo.md b/packages/sdk-vue/docs/interfaces/UserInfo.md index 9f11853..11226a3 100644 --- a/packages/sdk-vue/docs/interfaces/UserInfo.md +++ b/packages/sdk-vue/docs/interfaces/UserInfo.md @@ -11,14 +11,14 @@ User information returned from FusionAuth. - [applicationId](UserInfo.md#applicationid) - [birthdate](UserInfo.md#birthdate) - [email](UserInfo.md#email) -- [email_verified](UserInfo.md#email_verified) -- [family_name](UserInfo.md#family_name) -- [given_name](UserInfo.md#given_name) -- [middle_name](UserInfo.md#middle_name) +- [email\_verified](UserInfo.md#email_verified) +- [family\_name](UserInfo.md#family_name) +- [given\_name](UserInfo.md#given_name) +- [middle\_name](UserInfo.md#middle_name) - [name](UserInfo.md#name) -- [phone_number](UserInfo.md#phone_number) +- [phone\_number](UserInfo.md#phone_number) - [picture](UserInfo.md#picture) -- [preferred_username](UserInfo.md#preferred_username) +- [preferred\_username](UserInfo.md#preferred_username) - [roles](UserInfo.md#roles) - [sid](UserInfo.md#sid) - [sub](UserInfo.md#sub) @@ -32,9 +32,9 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:88](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L88) +[packages/sdk-vue/src/types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L101) ---- +___ ### birthdate @@ -42,9 +42,9 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:89](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L89) +[packages/sdk-vue/src/types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L102) ---- +___ ### email @@ -52,49 +52,49 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:90](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L90) +[packages/sdk-vue/src/types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L103) ---- +___ -### email_verified +### email\_verified -• `Optional` **email_verified**: `boolean` +• `Optional` **email\_verified**: `boolean` #### Defined in -[src/types.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L91) +[packages/sdk-vue/src/types.ts:104](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L104) ---- +___ -### family_name +### family\_name -• `Optional` **family_name**: `string` +• `Optional` **family\_name**: `string` #### Defined in -[src/types.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L92) +[packages/sdk-vue/src/types.ts:105](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L105) ---- +___ -### given_name +### given\_name -• `Optional` **given_name**: `string` +• `Optional` **given\_name**: `string` #### Defined in -[src/types.ts:93](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L93) +[packages/sdk-vue/src/types.ts:106](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L106) ---- +___ -### middle_name +### middle\_name -• `Optional` **middle_name**: `string` +• `Optional` **middle\_name**: `string` #### Defined in -[src/types.ts:95](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L95) +[packages/sdk-vue/src/types.ts:108](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L108) ---- +___ ### name @@ -102,19 +102,19 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L94) +[packages/sdk-vue/src/types.ts:107](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L107) ---- +___ -### phone_number +### phone\_number -• `Optional` **phone_number**: `string` +• `Optional` **phone\_number**: `string` #### Defined in -[src/types.ts:96](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L96) +[packages/sdk-vue/src/types.ts:109](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L109) ---- +___ ### picture @@ -122,19 +122,19 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:97](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L97) +[packages/sdk-vue/src/types.ts:110](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L110) ---- +___ -### preferred_username +### preferred\_username -• `Optional` **preferred_username**: `string` +• `Optional` **preferred\_username**: `string` #### Defined in -[src/types.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L98) +[packages/sdk-vue/src/types.ts:111](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L111) ---- +___ ### roles @@ -142,9 +142,9 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:99](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L99) +[packages/sdk-vue/src/types.ts:112](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L112) ---- +___ ### sid @@ -152,9 +152,9 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:100](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L100) +[packages/sdk-vue/src/types.ts:113](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L113) ---- +___ ### sub @@ -162,9 +162,9 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L101) +[packages/sdk-vue/src/types.ts:114](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L114) ---- +___ ### tid @@ -172,4 +172,4 @@ User information returned from FusionAuth. #### Defined in -[src/types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/types.ts#L102) +[packages/sdk-vue/src/types.ts:115](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L115) diff --git a/packages/sdk-vue/docs/modules.md b/packages/sdk-vue/docs/modules.md index c026c85..a61e9e4 100644 --- a/packages/sdk-vue/docs/modules.md +++ b/packages/sdk-vue/docs/modules.md @@ -38,31 +38,31 @@ Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) ---- +___ ### FusionAuthLogoutButton Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) ---- +___ ### FusionAuthRegisterButton Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) ---- +___ ### RequireAnonymous Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) ---- +___ ### RequireAuth Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) ---- +___ ### fusionAuthKey @@ -70,9 +70,9 @@ Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) #### Defined in -[src/injectionSymbols.ts:1](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/injectionSymbols.ts#L1) +[packages/sdk-vue/src/injectionSymbols.ts:1](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/injectionSymbols.ts#L1) ---- +___ ### createFusionAuth @@ -80,14 +80,14 @@ Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) #### Type parameters -| Name | Type | -| :--- | :----------------------------------- | -| `T` | [`UserInfo`](interfaces/UserInfo.md) | +| Name | Type | +| :------ | :------ | +| `T` | [`UserInfo`](interfaces/UserInfo.md) | #### Parameters -| Name | Type | -| :------- | :--------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `config` | [`FusionAuthConfig`](interfaces/FusionAuthConfig.md) | #### Returns @@ -96,9 +96,9 @@ Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) #### Defined in -[src/createFusionAuth/createFusionAuth.ts:7](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/createFusionAuth/createFusionAuth.ts#L7) +[packages/sdk-vue/src/createFusionAuth/createFusionAuth.ts:7](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/createFusionAuth/createFusionAuth.ts#L7) ---- +___ ### useFusionAuth @@ -106,9 +106,9 @@ Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) #### Type parameters -| Name | Type | -| :--- | :----------------------------------- | -| `T` | [`UserInfo`](interfaces/UserInfo.md) | +| Name | Type | +| :------ | :------ | +| `T` | [`UserInfo`](interfaces/UserInfo.md) | #### Returns @@ -116,7 +116,7 @@ Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) #### Defined in -[src/composables/useFusionAuth.ts:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/composables/useFusionAuth.ts#L5) +[packages/sdk-vue/src/composables/useFusionAuth.ts:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/composables/useFusionAuth.ts#L5) ## Plugin @@ -140,10 +140,10 @@ Will throw an error if the required options are missing. #### Type declaration -| Name | Type | -| :-------- | :----------------------------------------------------------------------------------------------------------------------------- | +| Name | Type | +| :------ | :------ | | `install` | (`app`: `App`\<`any`\>, `options`: [`FusionAuthConfig`](interfaces/FusionAuthConfig.md) \| `FusionAuthInstantiated`) => `void` | #### Defined in -[src/FusionAuthVuePlugin.ts:17](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/02b46e2174ba0f4804f6b5ef004ac88414902cc3/packages/sdk-vue/src/FusionAuthVuePlugin.ts#L17) +[packages/sdk-vue/src/FusionAuthVuePlugin.ts:17](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/FusionAuthVuePlugin.ts#L17) From ee8adbc65b4bc7586f80efa86002158c90d78a7e Mon Sep 17 00:00:00 2001 From: Mike Rudat Date: Sun, 2 Aug 2026 18:40:40 +0000 Subject: [PATCH 03/10] fix: regenerate SDK docs with prettier-safe formatting. - Add useCodeBlocks: true to sdk-angular's typedocOptions. Without it, typedoc-plugin-markdown@4's default blockquote-style signatures (e.g. `> **forRoot**(...): `ModuleWithProviders`\<`FusionAuthModule`\>`) trigger a prettier@3.9.6 markdown-formatter bug that inserts a stray '>' when reformatting an escaped '\>' immediately after inline code within a blockquote line. Fenced code blocks avoid the pattern entirely and are more readable besides. - Regenerate sdk-react and sdk-vue docs (picks up the latest commit hash in "Defined in" links) and run prettier --write across all three SDKs' generated docs. Verified every non-'***'->'---'-normalization diff (table column alignment, redundant double-backtick removal) is safe by diffing against the pre-write output; no content was altered or corrupted. --- .../FusionAuthAccountButtonComponent.md | 16 ++- .../classes/FusionAuthLoginButtonComponent.md | 22 +-- .../FusionAuthLogoutButtonComponent.md | 16 ++- .../docs/classes/FusionAuthModule.md | 14 +- .../FusionAuthRegisterButtonComponent.md | 22 +-- .../docs/classes/FusionAuthService.md | 126 +++++++++++------ packages/sdk-angular/docs/globals.md | 2 +- .../docs/interfaces/FusionAuthConfig.md | 130 +++++++++++------- .../sdk-angular/docs/interfaces/UserInfo.md | 122 +++++++++------- packages/sdk-angular/tsconfig.json | 3 +- ...ProviderConfig.FusionAuthProviderConfig.md | 88 ++++++------ ...oviderContext.FusionAuthProviderContext.md | 94 ++++++------- .../modules/providers_FusionAuthProvider.md | 24 ++-- .../docs/modules/ui_FusionAuthLoginButton.md | 6 +- .../docs/modules/ui_FusionAuthLogoutButton.md | 6 +- .../modules/ui_FusionAuthRegisterButton.md | 6 +- .../sdk-react/docs/modules/ui_RequireAuth.md | 6 +- .../docs/modules/ui_Unauthenticated.md | 8 +- .../sdk-vue/docs/interfaces/FusionAuth.md | 94 ++++++------- .../docs/interfaces/FusionAuthConfig.md | 108 +++++++-------- packages/sdk-vue/docs/interfaces/UserInfo.md | 58 ++++---- packages/sdk-vue/docs/modules.md | 42 +++--- 22 files changed, 569 insertions(+), 444 deletions(-) diff --git a/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md index 0176665..88f0117 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md @@ -1,20 +1,22 @@ [**@fusionauth/angular-sdk**](../README.md) -*** +--- [@fusionauth/angular-sdk](../globals.md) / FusionAuthAccountButtonComponent # Class: FusionAuthAccountButtonComponent -Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L10) +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L10) ## Constructors ### Constructor -> **new FusionAuthAccountButtonComponent**(`fusionAuth`): `FusionAuthAccountButtonComponent` +```ts +new FusionAuthAccountButtonComponent(fusionAuth): FusionAuthAccountButtonComponent; +``` -Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L11) +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L11) #### Parameters @@ -30,9 +32,11 @@ Defined in: [components/fusionauth-account.button/fusion-auth-account-button.com ### manageAccount() -> **manageAccount**(): `void` +```ts +manageAccount(): void; +``` -Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L13) +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L13) #### Returns diff --git a/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md index 05836f4..7d52d47 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md @@ -1,20 +1,22 @@ [**@fusionauth/angular-sdk**](../README.md) -*** +--- [@fusionauth/angular-sdk](../globals.md) / FusionAuthLoginButtonComponent # Class: FusionAuthLoginButtonComponent -Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L10) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L10) ## Constructors ### Constructor -> **new FusionAuthLoginButtonComponent**(`fusionAuth`): `FusionAuthLoginButtonComponent` +```ts +new FusionAuthLoginButtonComponent(fusionAuth): FusionAuthLoginButtonComponent; +``` -Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L13) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L13) #### Parameters @@ -30,17 +32,21 @@ Defined in: [components/fusionauth-login.button/fusion-auth-login-button.compone ### state -> **state**: `string` \| `undefined` +```ts +state: string | undefined; +``` -Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L11) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L11) ## Methods ### login() -> **login**(): `void` +```ts +login(): void; +``` -Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L15) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L15) #### Returns diff --git a/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md index 03c8bb1..0fd350c 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md @@ -1,20 +1,22 @@ [**@fusionauth/angular-sdk**](../README.md) -*** +--- [@fusionauth/angular-sdk](../globals.md) / FusionAuthLogoutButtonComponent # Class: FusionAuthLogoutButtonComponent -Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L13) +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L13) ## Constructors ### Constructor -> **new FusionAuthLogoutButtonComponent**(`fusionAuth`): `FusionAuthLogoutButtonComponent` +```ts +new FusionAuthLogoutButtonComponent(fusionAuth): FusionAuthLogoutButtonComponent; +``` -Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L14) +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L14) #### Parameters @@ -30,9 +32,11 @@ Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.compo ### logout() -> **logout**(): `void` +```ts +logout(): void; +``` -Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L16) +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L16) #### Returns diff --git a/packages/sdk-angular/docs/classes/FusionAuthModule.md b/packages/sdk-angular/docs/classes/FusionAuthModule.md index 37552f8..e30ff56 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthModule.md +++ b/packages/sdk-angular/docs/classes/FusionAuthModule.md @@ -1,18 +1,20 @@ [**@fusionauth/angular-sdk**](../README.md) -*** +--- [@fusionauth/angular-sdk](../globals.md) / FusionAuthModule # Class: FusionAuthModule -Defined in: [fusion-auth.module.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L25) +Defined in: [fusion-auth.module.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L25) ## Constructors ### Constructor -> **new FusionAuthModule**(): `FusionAuthModule` +```ts +new FusionAuthModule(): FusionAuthModule; +``` #### Returns @@ -22,9 +24,11 @@ Defined in: [fusion-auth.module.ts:25](https://github.com/FusionAuth/fusionauth- ### forRoot() -> `static` **forRoot**(`fusionAuthConfig`): `ModuleWithProviders`\<`FusionAuthModule`\> +```ts +static forRoot(fusionAuthConfig): ModuleWithProviders; +``` -Defined in: [fusion-auth.module.ts:26](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L26) +Defined in: [fusion-auth.module.ts:26](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L26) #### Parameters diff --git a/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md index 801450a..3720b0d 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md @@ -1,20 +1,22 @@ [**@fusionauth/angular-sdk**](../README.md) -*** +--- [@fusionauth/angular-sdk](../globals.md) / FusionAuthRegisterButtonComponent # Class: FusionAuthRegisterButtonComponent -Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L13) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L13) ## Constructors ### Constructor -> **new FusionAuthRegisterButtonComponent**(`fusionAuth`): `FusionAuthRegisterButtonComponent` +```ts +new FusionAuthRegisterButtonComponent(fusionAuth): FusionAuthRegisterButtonComponent; +``` -Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L16) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L16) #### Parameters @@ -30,17 +32,21 @@ Defined in: [components/fusionauth-register.button/fusion-auth-register-button.c ### state -> **state**: `string` \| `undefined` +```ts +state: string | undefined; +``` -Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L14) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L14) ## Methods ### register() -> **register**(): `void` +```ts +register(): void; +``` -Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L18) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L18) #### Returns diff --git a/packages/sdk-angular/docs/classes/FusionAuthService.md b/packages/sdk-angular/docs/classes/FusionAuthService.md index cb8d5ac..d0d2558 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthService.md +++ b/packages/sdk-angular/docs/classes/FusionAuthService.md @@ -1,12 +1,12 @@ [**@fusionauth/angular-sdk**](../README.md) -*** +--- [@fusionauth/angular-sdk](../globals.md) / FusionAuthService # Class: FusionAuthService\ -Defined in: [fusion-auth.service.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L24) +Defined in: [fusion-auth.service.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L24) Service class to use with FusionAuth backend endpoints. @@ -20,9 +20,15 @@ Service class to use with FusionAuth backend endpoints. ### Constructor -> **new FusionAuthService**\<`T`\>(`config`, `platformId`, `ngZone`, `appRef`): `FusionAuthService`\<`T`\> +```ts +new FusionAuthService( + config, + platformId, + ngZone, +appRef): FusionAuthService; +``` -Defined in: [fusion-auth.service.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L29) +Defined in: [fusion-auth.service.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L29) #### Parameters @@ -50,19 +56,23 @@ Defined in: [fusion-auth.service.ts:29](https://github.com/FusionAuth/fusionauth ### isLoggedIn$ -> **isLoggedIn$**: `Observable`\<`boolean`\> +```ts +isLoggedIn$: Observable; +``` -Defined in: [fusion-auth.service.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L68) +Defined in: [fusion-auth.service.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L68) An observable representing whether the user is logged in. -*** +--- ### isLoggedInSignal -> **isLoggedInSignal**: `Signal`\<`boolean`\> +```ts +isLoggedInSignal: Signal; +``` -Defined in: [fusion-auth.service.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L73) +Defined in: [fusion-auth.service.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L73) A Signal representing whether the user is logged in. @@ -70,9 +80,11 @@ A Signal representing whether the user is logged in. ### dpopFetch() -> **dpopFetch**(`input`, `init?`): `Promise`\<`Response`\> +```ts +dpopFetch(input, init?): Promise; +``` -Defined in: [fusion-auth.service.ts:177](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L177) +Defined in: [fusion-auth.service.ts:177](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L177) DPoP mode `fetch()` wrapper that automatically attaches DPoP proof headers. @@ -95,13 +107,19 @@ headers. if called when `useDpop` is not enabled. -*** +--- ### generateProof() -> **generateProof**(`htu`, `htm`, `accessToken?`, `nonce?`): `Promise`\<`string`\> +```ts +generateProof( + htu, + htm, + accessToken?, +nonce?): Promise; +``` -Defined in: [fusion-auth.service.ts:189](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L189) +Defined in: [fusion-auth.service.ts:189](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L189) Returns a signed DPoP proof JWT for use with axios or other HTTP libraries that can't use [dpopFetch](#dpopfetch). @@ -132,13 +150,15 @@ HTTP libraries that can't use [dpopFetch](#dpopfetch). if called when `useDpop` is not enabled. -*** +--- ### getAccessToken() -> **getAccessToken**(): `string` \| `null` +```ts +getAccessToken(): string | null; +``` -Defined in: [fusion-auth.service.ts:202](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L202) +Defined in: [fusion-auth.service.ts:202](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L202) Returns the stored DPoP access token, or `null` if not logged in. @@ -150,13 +170,15 @@ Returns the stored DPoP access token, or `null` if not logged in. if called when `useDpop` is not enabled. -*** +--- ### getUserInfo() -> **getUserInfo**\<`T`\>(): `Promise`\<`T`\> +```ts +getUserInfo(): Promise; +``` -Defined in: [fusion-auth.service.ts:131](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L131) +Defined in: [fusion-auth.service.ts:131](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L131) Fetches userInfo from the 'me' endpoint. @@ -174,13 +196,15 @@ Fetches userInfo from the 'me' endpoint. - if an error occurred while fetching. -*** +--- ### getUserInfoObservable() -> **getUserInfoObservable**(`callbacks?`): `Observable`\<`T`\> +```ts +getUserInfoObservable(callbacks?): Observable; +``` -Defined in: [fusion-auth.service.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L103) +Defined in: [fusion-auth.service.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L103) Returns an observable request that fetches userInfo, and catches error. @@ -200,13 +224,15 @@ Returns an observable request that fetches userInfo, and catches error. `Observable`\<`T`\> -*** +--- ### initAutoRefresh() -> **initAutoRefresh**(): `void` +```ts +initAutoRefresh(): void; +``` -Defined in: [fusion-auth.service.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L92) +Defined in: [fusion-auth.service.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L92) Initializes automatic access token refreshing. This is handled automatically if the SDK is configured with `shouldAutoRefresh`. @@ -215,13 +241,15 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. `void` -*** +--- ### isLoggedIn() -> **isLoggedIn**(): `boolean` +```ts +isLoggedIn(): boolean; +``` -Defined in: [fusion-auth.service.ts:76](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L76) +Defined in: [fusion-auth.service.ts:76](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L76) A function that returns whether the user is logged in. This returned value is non-observable. @@ -229,13 +257,15 @@ A function that returns whether the user is logged in. This returned value is no `boolean` -*** +--- ### logout() -> **logout**(): `void` +```ts +logout(): void; +``` -Defined in: [fusion-auth.service.ts:160](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L160) +Defined in: [fusion-auth.service.ts:160](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L160) Initiates logout flow. @@ -243,13 +273,15 @@ Initiates logout flow. `void` -*** +--- ### manageAccount() -> **manageAccount**(): `void` +```ts +manageAccount(): void; +``` -Defined in: [fusion-auth.service.ts:168](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L168) +Defined in: [fusion-auth.service.ts:168](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L168) Redirects to [self service account management](https://fusionauth.io/docs/lifecycle/manage-users/account-management/) Self service account management is only available in FusionAuth paid plans. @@ -258,13 +290,15 @@ Self service account management is only available in FusionAuth paid plans. `void` -*** +--- ### refreshToken() -> **refreshToken**(): `Promise`\<`Response`\> +```ts +refreshToken(): Promise; +``` -Defined in: [fusion-auth.service.ts:84](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L84) +Defined in: [fusion-auth.service.ts:84](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L84) Refreshes the access token a single time. Automatic token refreshing can be enabled if the SDK is configured with `shouldAutoRefresh`. @@ -273,13 +307,15 @@ Automatic token refreshing can be enabled if the SDK is configured with `shouldA `Promise`\<`Response`\> -*** +--- ### startLogin() -> **startLogin**(`state?`): `void` +```ts +startLogin(state?): void; +``` -Defined in: [fusion-auth.service.ts:145](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L145) +Defined in: [fusion-auth.service.ts:145](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L145) Initiates login flow. @@ -295,13 +331,15 @@ Optional value to be echoed back to the SDK upon redirect. `void` -*** +--- ### startRegistration() -> **startRegistration**(`state?`): `void` +```ts +startRegistration(state?): void; +``` -Defined in: [fusion-auth.service.ts:153](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L153) +Defined in: [fusion-auth.service.ts:153](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L153) Initiates register flow. diff --git a/packages/sdk-angular/docs/globals.md b/packages/sdk-angular/docs/globals.md index c257bfe..d75fa4b 100644 --- a/packages/sdk-angular/docs/globals.md +++ b/packages/sdk-angular/docs/globals.md @@ -1,6 +1,6 @@ [**@fusionauth/angular-sdk**](README.md) -*** +--- # @fusionauth/angular-sdk diff --git a/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md b/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md index c66b542..6521f55 100644 --- a/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md +++ b/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md @@ -1,12 +1,12 @@ [**@fusionauth/angular-sdk**](../README.md) -*** +--- [@fusionauth/angular-sdk](../globals.md) / FusionAuthConfig # Interface: FusionAuthConfig -Defined in: [types.ts:4](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L4) +Defined in: [types.ts:4](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L4) Config for FusionAuth Angular SDK @@ -14,70 +14,84 @@ Config for FusionAuth Angular SDK ### autoRefreshSecondsBeforeExpiry? -> `optional` **autoRefreshSecondsBeforeExpiry?**: `number` +```ts +optional autoRefreshSecondsBeforeExpiry?: number; +``` -Defined in: [types.ts:38](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L38) +Defined in: [types.ts:38](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L38) The number of seconds before the access token expiry when the auto refresh functionality kicks in if enabled. Default is 10. -*** +--- ### clientId -> **clientId**: `string` +```ts +clientId: string; +``` -Defined in: [types.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L13) +Defined in: [types.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L13) The client id of the application. -*** +--- ### dpopTokenStorage? -> `optional` **dpopTokenStorage?**: `"localStorage"` \| `"memory"` +```ts +optional dpopTokenStorage?: "localStorage" | "memory"; +``` -Defined in: [types.ts:86](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L86) +Defined in: [types.ts:86](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L86) Token storage location in DPoP mode. Only meaningful when `useDpop: true`. Defaults to `'localStorage'`. -*** +--- ### loginPath? -> `optional` **loginPath?**: `string` +```ts +optional loginPath?: string; +``` -Defined in: [types.ts:53](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L53) +Defined in: [types.ts:53](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L53) The path to the login endpoint. -*** +--- ### logoutPath? -> `optional` **logoutPath?**: `string` +```ts +optional logoutPath?: string; +``` -Defined in: [types.ts:63](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L63) +Defined in: [types.ts:63](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L63) The path to the logout endpoint. -*** +--- ### mePath? -> `optional` **mePath?**: `string` +```ts +optional mePath?: string; +``` -Defined in: [types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L73) +Defined in: [types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L73) The path to the me endpoint. -*** +--- ### onAutoRefreshFailure? -> `optional` **onAutoRefreshFailure?**: (`error`) => `void` +```ts +optional onAutoRefreshFailure?: (error) => void; +``` -Defined in: [types.ts:48](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L48) +Defined in: [types.ts:48](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L48) Callback to be invoked if a request to refresh the access token fails during autorefresh. @@ -91,13 +105,15 @@ Callback to be invoked if a request to refresh the access token fails during aut `void` -*** +--- ### onRedirect? -> `optional` **onRedirect?**: (`state?`) => `void` +```ts +optional onRedirect?: (state?) => void; +``` -Defined in: [types.ts:43](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L43) +Defined in: [types.ts:43](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L43) Callback function to be invoked with the `state` value upon redirect from login or register. @@ -111,83 +127,99 @@ Callback function to be invoked with the `state` value upon redirect from login `void` -*** +--- ### postLogoutRedirectUri? -> `optional` **postLogoutRedirectUri?**: `string` +```ts +optional postLogoutRedirectUri?: string; +``` -Defined in: [types.ts:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L23) +Defined in: [types.ts:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L23) The redirect URI for post-logout. Defaults the provided `redirectUri`. -*** +--- ### redirectUri -> **redirectUri**: `string` +```ts +redirectUri: string; +``` -Defined in: [types.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L18) +Defined in: [types.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L18) The redirect URI of the application. -*** +--- ### registerPath? -> `optional` **registerPath?**: `string` +```ts +optional registerPath?: string; +``` -Defined in: [types.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L58) +Defined in: [types.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L58) The path to the register endpoint. -*** +--- ### scope? -> `optional` **scope?**: `string` +```ts +optional scope?: string; +``` -Defined in: [types.ts:28](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L28) +Defined in: [types.ts:28](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L28) The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not specified fusionauth will default this to `openid offline_access`. -*** +--- ### serverUrl -> **serverUrl**: `string` +```ts +serverUrl: string; +``` -Defined in: [types.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L8) +Defined in: [types.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L8) The URL of the server that performs the token exchange. -*** +--- ### shouldAutoRefresh? -> `optional` **shouldAutoRefresh?**: `boolean` +```ts +optional shouldAutoRefresh?: boolean; +``` -Defined in: [types.ts:33](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L33) +Defined in: [types.ts:33](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L33) Enables automatic token refreshing. Defaults to false. -*** +--- ### tokenRefreshPath? -> `optional` **tokenRefreshPath?**: `string` +```ts +optional tokenRefreshPath?: string; +``` -Defined in: [types.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L68) +Defined in: [types.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L68) The path to the token refresh endpoint. -*** +--- ### useDpop? -> `optional` **useDpop?**: `boolean` +```ts +optional useDpop?: boolean; +``` -Defined in: [types.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L80) +Defined in: [types.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L80) Opt-in to DPoP mode. When `true`, the SDK calls FusionAuth endpoints directly and stores tokens in JavaScript-accessible storage instead of diff --git a/packages/sdk-angular/docs/interfaces/UserInfo.md b/packages/sdk-angular/docs/interfaces/UserInfo.md index 41d9cee..edf5045 100644 --- a/packages/sdk-angular/docs/interfaces/UserInfo.md +++ b/packages/sdk-angular/docs/interfaces/UserInfo.md @@ -1,129 +1,159 @@ [**@fusionauth/angular-sdk**](../README.md) -*** +--- [@fusionauth/angular-sdk](../globals.md) / UserInfo # Interface: UserInfo -Defined in: [types.ts:89](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L89) +Defined in: [types.ts:89](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L89) ## Properties ### applicationId? -> `optional` **applicationId?**: `string` +```ts +optional applicationId?: string; +``` -Defined in: [types.ts:90](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L90) +Defined in: [types.ts:90](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L90) -*** +--- ### birthdate? -> `optional` **birthdate?**: `string` +```ts +optional birthdate?: string; +``` -Defined in: [types.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L91) +Defined in: [types.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L91) -*** +--- ### email? -> `optional` **email?**: `string` +```ts +optional email?: string; +``` -Defined in: [types.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L92) +Defined in: [types.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L92) -*** +--- ### email\_verified? -> `optional` **email\_verified?**: `boolean` +```ts +optional email_verified?: boolean; +``` -Defined in: [types.ts:93](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L93) +Defined in: [types.ts:93](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L93) -*** +--- ### family\_name? -> `optional` **family\_name?**: `string` +```ts +optional family_name?: string; +``` -Defined in: [types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L94) +Defined in: [types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L94) -*** +--- ### given\_name? -> `optional` **given\_name?**: `string` +```ts +optional given_name?: string; +``` -Defined in: [types.ts:95](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L95) +Defined in: [types.ts:95](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L95) -*** +--- ### middle\_name? -> `optional` **middle\_name?**: `string` +```ts +optional middle_name?: string; +``` -Defined in: [types.ts:96](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L96) +Defined in: [types.ts:96](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L96) -*** +--- ### name? -> `optional` **name?**: `string` +```ts +optional name?: string; +``` -Defined in: [types.ts:97](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L97) +Defined in: [types.ts:97](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L97) -*** +--- ### phone\_number? -> `optional` **phone\_number?**: `string` +```ts +optional phone_number?: string; +``` -Defined in: [types.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L98) +Defined in: [types.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L98) -*** +--- ### picture? -> `optional` **picture?**: `string` +```ts +optional picture?: string; +``` -Defined in: [types.ts:99](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L99) +Defined in: [types.ts:99](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L99) -*** +--- ### preferred\_username? -> `optional` **preferred\_username?**: `string` +```ts +optional preferred_username?: string; +``` -Defined in: [types.ts:100](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L100) +Defined in: [types.ts:100](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L100) -*** +--- ### roles? -> `optional` **roles?**: `any`[] +```ts +optional roles?: any[]; +``` -Defined in: [types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L101) +Defined in: [types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L101) -*** +--- ### sid? -> `optional` **sid?**: `string` +```ts +optional sid?: string; +``` -Defined in: [types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L102) +Defined in: [types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L102) -*** +--- ### sub? -> `optional` **sub?**: `string` +```ts +optional sub?: string; +``` -Defined in: [types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L103) +Defined in: [types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L103) -*** +--- ### tid? -> `optional` **tid?**: `string` +```ts +optional tid?: string; +``` -Defined in: [types.ts:104](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L104) +Defined in: [types.ts:104](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L104) diff --git a/packages/sdk-angular/tsconfig.json b/packages/sdk-angular/tsconfig.json index fccc0be..a65dc4c 100644 --- a/packages/sdk-angular/tsconfig.json +++ b/packages/sdk-angular/tsconfig.json @@ -39,6 +39,7 @@ "typedocOptions": { "plugin": ["typedoc-plugin-markdown"], "entryPoints": ["projects/fusionauth-angular-sdk/src/public-api.ts"], - "out": "docs" + "out": "docs", + "useCodeBlocks": true } } diff --git a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md index 258c71b..986e8eb 100644 --- a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md +++ b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md @@ -42,21 +42,21 @@ Only set this if you are hosting server that uses a custom name for the 'app.at_ #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L98) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L98) -___ +--- ### authParams -• `Optional` **authParams**: \{ `[key: string]`: `any`; }[] +• `Optional` **authParams**: \{ `[key: string]`: `any`; }[] Additional params passed to loginPath typically `/app/login/`, which redirects to `/oauth2/authorize`. Example of this might be loginParams = [{idp_hint:'44449786-3dff-42a6-aac6-1f1ceecb6c46'}] or any params found at https://fusionauth.io/docs/lifecycle/authenticate-users/oauth/endpoints #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:30](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L30) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:30](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L30) -___ +--- ### autoRefreshSecondsBeforeExpiry @@ -66,9 +66,9 @@ The number of seconds before the access token expiry when the auto refresh funct #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:50](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L50) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:50](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L50) -___ +--- ### clientId @@ -78,22 +78,22 @@ The client id of the application. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L15) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L15) -___ +--- ### dpopTokenStorage -• `Optional` **dpopTokenStorage**: ``"localStorage"`` \| ``"memory"`` +• `Optional` **dpopTokenStorage**: `"localStorage"` \| `"memory"` Token storage location in DPoP mode. Only meaningful when `useDpop: true`. Defaults to `'localStorage'`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:111](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L111) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:111](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L111) -___ +--- ### loginPath @@ -103,9 +103,9 @@ The path to the login endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L65) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L65) -___ +--- ### logoutPath @@ -115,9 +115,9 @@ The path to the logout endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:75](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L75) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:75](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L75) -___ +--- ### mePath @@ -127,9 +127,9 @@ The path to the me endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L92) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L92) -___ +--- ### nextCookieAdapter @@ -149,9 +149,9 @@ See docs for [configuration with nextjs](https://github.com/FusionAuth/fusionaut #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:87](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L87) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:87](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L87) -___ +--- ### onAutoRefreshFailure @@ -165,7 +165,7 @@ Callback to be invoked if a request to refresh the access token fails during aut ##### Parameters -| Name | Type | +| Name | Type | | :------ | :------ | | `error` | `Error` | @@ -175,9 +175,9 @@ Callback to be invoked if a request to refresh the access token fails during aut #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L60) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L60) -___ +--- ### onRedirect @@ -191,8 +191,8 @@ Callback function to be invoked with the `state` value upon redirect from login ##### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------- | :------- | | `state?` | `string` | ##### Returns @@ -201,9 +201,9 @@ Callback function to be invoked with the `state` value upon redirect from login #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:55](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L55) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:55](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L55) -___ +--- ### postLogoutRedirectUri @@ -213,9 +213,9 @@ The redirect URI for post-logout. Defaults the provided `redirectUri`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L35) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L35) -___ +--- ### redirectUri @@ -225,9 +225,9 @@ The redirect URI of the application. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:20](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L20) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:20](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L20) -___ +--- ### registerPath @@ -237,9 +237,9 @@ The path to the register endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L70) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L70) -___ +--- ### scope @@ -249,9 +249,9 @@ The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not sp #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L25) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L25) -___ +--- ### serverUrl @@ -261,9 +261,9 @@ The URL of the server that performs the token exchange. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L10) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L10) -___ +--- ### shouldAutoFetchUserInfo @@ -273,9 +273,9 @@ Enables the SDK to automatically handle fetching user info when logged in. Defau #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:45](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L45) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:45](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L45) -___ +--- ### shouldAutoRefresh @@ -285,9 +285,9 @@ Enables automatic token refreshing. Defaults to false. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:40](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L40) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:40](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L40) -___ +--- ### tokenRefreshPath @@ -297,9 +297,9 @@ The path to the token refresh endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L80) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L80) -___ +--- ### useDpop @@ -311,4 +311,4 @@ relying on the Hosted Backend's HttpOnly cookies. Defaults to `false`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:105](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L105) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:105](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L105) diff --git a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md index 518188a..8785d57 100644 --- a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md +++ b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md @@ -8,9 +8,9 @@ The context provided by FusionAuth React SDK ## Type parameters -| Name | Type | -| :------ | :------ | -| `T` | `UserInfo` | +| Name | Type | +| :--- | :--------- | +| `T` | `UserInfo` | ## Table of contents @@ -46,10 +46,10 @@ Present only when `useDpop: true`. ##### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------ | :--------------------- | | `input` | `RequestInfo` \| `URL` | -| `init?` | `RequestInit` | +| `init?` | `RequestInit` | ##### Returns @@ -57,21 +57,21 @@ Present only when `useDpop: true`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L70) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L70) -___ +--- ### error -• **error**: ``null`` \| `Error` +• **error**: `null` \| `Error` Error occurred while fetching userInfo. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L29) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L29) -___ +--- ### fetchUserInfo @@ -90,9 +90,9 @@ This is handled automatically if the SDK is configured with `shouldAutoFetchUser #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L19) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L19) -___ +--- ### generateProof @@ -107,12 +107,12 @@ HTTP libraries. Present only when `useDpop: true`. ##### Parameters -| Name | Type | -| :------ | :------ | -| `htu` | `string` | -| `htm` | `string` | +| Name | Type | +| :------------- | :------- | +| `htu` | `string` | +| `htm` | `string` | | `accessToken?` | `string` | -| `nonce?` | `string` | +| `nonce?` | `string` | ##### Returns @@ -120,13 +120,13 @@ HTTP libraries. Present only when `useDpop: true`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:79](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L79) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:79](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L79) -___ +--- ### getAccessToken -• `Optional` **getAccessToken**: () => ``null`` \| `string` +• `Optional` **getAccessToken**: () => `null` \| `string` Returns the stored DPoP access token, or `null` if not logged in. Throws a descriptive error when `useDpop: false`. @@ -134,17 +134,17 @@ Present only when `useDpop: true`. #### Type declaration -▸ (): ``null`` \| `string` +▸ (): `null` \| `string` ##### Returns -``null`` \| `string` +`null` \| `string` #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L91) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L91) -___ +--- ### initAutoRefresh @@ -163,9 +163,9 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:64](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L64) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:64](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L64) -___ +--- ### isFetchingUserInfo @@ -175,9 +175,9 @@ Indicates that the fetchUserInfo call is unresolved. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L24) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L24) -___ +--- ### isLoggedIn @@ -187,9 +187,9 @@ Whether the user is logged in. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L8) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L8) -___ +--- ### manageAccount @@ -208,9 +208,9 @@ Self service account management is only available in FusionAuth paid plans. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:52](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L52) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:52](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L52) -___ +--- ### refreshToken @@ -229,9 +229,9 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L58) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L58) -___ +--- ### startLogin @@ -245,8 +245,8 @@ Initiates login flow. ##### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | +| Name | Type | Description | +| :------- | :------- | :--------------------------------------------------------- | | `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | ##### Returns @@ -255,9 +255,9 @@ Initiates login flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L35) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L35) -___ +--- ### startLogout @@ -275,9 +275,9 @@ Initiates logout flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:46](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L46) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:46](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L46) -___ +--- ### startRegister @@ -291,8 +291,8 @@ Initiates register flow. ##### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | +| Name | Type | Description | +| :------- | :------- | :--------------------------------------------------------- | | `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | ##### Returns @@ -301,16 +301,16 @@ Initiates register flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:41](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L41) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:41](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L41) -___ +--- ### userInfo -• **userInfo**: ``null`` \| `T` +• **userInfo**: `null` \| `T` Data fetched from the configured 'me' endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L13) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L13) diff --git a/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md b/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md index a32cd97..5a4ee2d 100644 --- a/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md +++ b/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md @@ -17,15 +17,15 @@ #### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | `UserInfo` | +| Name | Type | +| :--- | :--------- | +| `T` | `UserInfo` | #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | \{ `children?`: `ReactNode` } & [`FusionAuthProviderConfig`](../interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md) | +| Name | Type | +| :------ | :----------------------------------------------------------------------------------------------------------------------------------------- | +| `props` | \{ `children?`: `ReactNode` } & [`FusionAuthProviderConfig`](../interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md) | #### Returns @@ -33,9 +33,9 @@ #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L23) +[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L23) -___ +--- ### useFusionAuth @@ -45,9 +45,9 @@ A hook that returns `FusionAuthProviderContext` #### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | `UserInfo` | +| Name | Type | +| :--- | :--------- | +| `T` | `UserInfo` | #### Returns @@ -55,4 +55,4 @@ A hook that returns `FusionAuthProviderContext` #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:155](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L155) +[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:155](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L155) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md index 9b325fd..91ac65b 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md @@ -18,8 +18,8 @@ Calls the `startLogin` method from `FusionAuthProviderContext`. #### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------ | :--------------------------- | | `props` | `FusionAuthLoginButtonProps` | #### Returns @@ -28,4 +28,4 @@ Calls the `startLogin` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx#L16) +[packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx#L16) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md index be1cc64..522ea96 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md @@ -18,8 +18,8 @@ Calls the `startLogout` method from `FusionAuthProviderContext`. #### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------ | :---------------------------- | | `props` | `FusionAuthLogoutButtonProps` | #### Returns @@ -28,4 +28,4 @@ Calls the `startLogout` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx#L13) +[packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx#L13) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md index 1ab69fb..4d8847d 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md @@ -18,8 +18,8 @@ Calls the `startRegister` method from `FusionAuthProviderContext`. #### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------ | :------------------------------ | | `props` | `FusionAuthRegisterButtonProps` | #### Returns @@ -28,4 +28,4 @@ Calls the `startRegister` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx#L15) +[packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx#L15) diff --git a/packages/sdk-react/docs/modules/ui_RequireAuth.md b/packages/sdk-react/docs/modules/ui_RequireAuth.md index 1c08263..167dd16 100644 --- a/packages/sdk-react/docs/modules/ui_RequireAuth.md +++ b/packages/sdk-react/docs/modules/ui_RequireAuth.md @@ -18,8 +18,8 @@ Only renders children when user is authenticated. #### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------ | :----------------- | | `props` | `RequireAuthProps` | #### Returns @@ -28,4 +28,4 @@ Only renders children when user is authenticated. #### Defined in -[packages/sdk-react/src/components/ui/RequireAuth/index.tsx:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/RequireAuth/index.tsx#L10) +[packages/sdk-react/src/components/ui/RequireAuth/index.tsx:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/RequireAuth/index.tsx#L10) diff --git a/packages/sdk-react/docs/modules/ui_Unauthenticated.md b/packages/sdk-react/docs/modules/ui_Unauthenticated.md index d402054..1238734 100644 --- a/packages/sdk-react/docs/modules/ui_Unauthenticated.md +++ b/packages/sdk-react/docs/modules/ui_Unauthenticated.md @@ -18,9 +18,9 @@ Only renders children when user is unauthenticated. #### Parameters -| Name | Type | -| :------ | :------ | -| `props` | `Object` | +| Name | Type | +| :---------------- | :---------- | +| `props` | `Object` | | `props.children?` | `ReactNode` | #### Returns @@ -29,4 +29,4 @@ Only renders children when user is unauthenticated. #### Defined in -[packages/sdk-react/src/components/ui/Unauthenticated/index.tsx:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-react/src/components/ui/Unauthenticated/index.tsx#L5) +[packages/sdk-react/src/components/ui/Unauthenticated/index.tsx:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/Unauthenticated/index.tsx#L5) diff --git a/packages/sdk-vue/docs/interfaces/FusionAuth.md b/packages/sdk-vue/docs/interfaces/FusionAuth.md index 26c30e9..af6a357 100644 --- a/packages/sdk-vue/docs/interfaces/FusionAuth.md +++ b/packages/sdk-vue/docs/interfaces/FusionAuth.md @@ -6,9 +6,9 @@ FusionAuth object provided at app-level by FusionAuthVuePlugin ## Type parameters -| Name | Type | -| :------ | :------ | -| `T` | [`UserInfo`](UserInfo.md) | +| Name | Type | +| :--- | :------------------------ | +| `T` | [`UserInfo`](UserInfo.md) | ## Table of contents @@ -44,10 +44,10 @@ Present only when `useDpop: true`. ##### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------ | :--------------------- | | `input` | `RequestInfo` \| `URL` | -| `init?` | `RequestInit` | +| `init?` | `RequestInit` | ##### Returns @@ -55,21 +55,21 @@ Present only when `useDpop: true`. #### Defined in -[packages/sdk-vue/src/types.ts:188](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L188) +[packages/sdk-vue/src/types.ts:188](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L188) -___ +--- ### error -• **error**: `Ref`\<``null`` \| `Error`, ``null`` \| `Error`\> +• **error**: `Ref`\<`null` \| `Error`, `null` \| `Error`\> Error occurred within getUserInfo. #### Defined in -[packages/sdk-vue/src/types.ts:147](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L147) +[packages/sdk-vue/src/types.ts:147](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L147) -___ +--- ### generateProof @@ -84,12 +84,12 @@ HTTP libraries. Present only when `useDpop: true`. ##### Parameters -| Name | Type | -| :------ | :------ | -| `htu` | `string` | -| `htm` | `string` | +| Name | Type | +| :------------- | :------- | +| `htu` | `string` | +| `htm` | `string` | | `accessToken?` | `string` | -| `nonce?` | `string` | +| `nonce?` | `string` | ##### Returns @@ -97,13 +97,13 @@ HTTP libraries. Present only when `useDpop: true`. #### Defined in -[packages/sdk-vue/src/types.ts:197](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L197) +[packages/sdk-vue/src/types.ts:197](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L197) -___ +--- ### getAccessToken -• `Optional` **getAccessToken**: () => ``null`` \| `string` +• `Optional` **getAccessToken**: () => `null` \| `string` Returns the stored DPoP access token, or `null` if not logged in. Throws a descriptive error when `useDpop: false`. @@ -111,17 +111,17 @@ Present only when `useDpop: true`. #### Type declaration -▸ (): ``null`` \| `string` +▸ (): `null` \| `string` ##### Returns -``null`` \| `string` +`null` \| `string` #### Defined in -[packages/sdk-vue/src/types.ts:209](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L209) +[packages/sdk-vue/src/types.ts:209](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L209) -___ +--- ### getUserInfo @@ -140,9 +140,9 @@ Internally updates `isFetchingUser` and `userInfo` refs, as well as `error` if t #### Defined in -[packages/sdk-vue/src/types.ts:132](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L132) +[packages/sdk-vue/src/types.ts:132](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L132) -___ +--- ### initAutoRefresh @@ -161,9 +161,9 @@ Refresh is scheduled to happen at the configured `autoRefreshSecondsBeforeExpiry #### Defined in -[packages/sdk-vue/src/types.ts:182](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L182) +[packages/sdk-vue/src/types.ts:182](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L182) -___ +--- ### isGettingUserInfo @@ -173,9 +173,9 @@ Indicates that the getUserInfo call is unresolved. #### Defined in -[packages/sdk-vue/src/types.ts:142](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L142) +[packages/sdk-vue/src/types.ts:142](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L142) -___ +--- ### isLoggedIn @@ -185,9 +185,9 @@ Whether the user is logged in. #### Defined in -[packages/sdk-vue/src/types.ts:125](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L125) +[packages/sdk-vue/src/types.ts:125](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L125) -___ +--- ### login @@ -201,8 +201,8 @@ Initiates login flow. ##### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | +| Name | Type | Description | +| :------- | :------- | :--------------------------------------------------------- | | `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | ##### Returns @@ -211,9 +211,9 @@ Initiates login flow. #### Defined in -[packages/sdk-vue/src/types.ts:153](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L153) +[packages/sdk-vue/src/types.ts:153](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L153) -___ +--- ### logout @@ -231,9 +231,9 @@ Initiates a logout. #### Defined in -[packages/sdk-vue/src/types.ts:164](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L164) +[packages/sdk-vue/src/types.ts:164](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L164) -___ +--- ### manageAccount @@ -252,9 +252,9 @@ Self service account management is only available in FusionAuth paid plans. #### Defined in -[packages/sdk-vue/src/types.ts:170](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L170) +[packages/sdk-vue/src/types.ts:170](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L170) -___ +--- ### refreshToken @@ -273,9 +273,9 @@ Token refreshing is handled automatically if configured with `shouldAutoRefresh` #### Defined in -[packages/sdk-vue/src/types.ts:176](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L176) +[packages/sdk-vue/src/types.ts:176](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L176) -___ +--- ### register @@ -289,8 +289,8 @@ Initiates register flow. ##### Parameters -| Name | Type | Description | -| :------ | :------ | :------ | +| Name | Type | Description | +| :------- | :------- | :--------------------------------------------------------- | | `state?` | `string` | Optional value to be echoed back to the SDK upon redirect. | ##### Returns @@ -299,16 +299,16 @@ Initiates register flow. #### Defined in -[packages/sdk-vue/src/types.ts:159](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L159) +[packages/sdk-vue/src/types.ts:159](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L159) -___ +--- ### userInfo -• **userInfo**: `Ref`\<``null`` \| `T`, ``null`` \| `T`\> +• **userInfo**: `Ref`\<`null` \| `T`, `null` \| `T`\> Data fetched from the configured 'me' endpoint. #### Defined in -[packages/sdk-vue/src/types.ts:137](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L137) +[packages/sdk-vue/src/types.ts:137](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L137) diff --git a/packages/sdk-vue/docs/interfaces/FusionAuthConfig.md b/packages/sdk-vue/docs/interfaces/FusionAuthConfig.md index 0a6383f..3ff0d82 100644 --- a/packages/sdk-vue/docs/interfaces/FusionAuthConfig.md +++ b/packages/sdk-vue/docs/interfaces/FusionAuthConfig.md @@ -37,9 +37,9 @@ The number of seconds before the access token expiry when the auto refresh funct #### Defined in -[packages/sdk-vue/src/types.ts:44](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L44) +[packages/sdk-vue/src/types.ts:44](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L44) -___ +--- ### clientId @@ -49,22 +49,22 @@ The client id of the application. #### Defined in -[packages/sdk-vue/src/types.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L15) +[packages/sdk-vue/src/types.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L15) -___ +--- ### dpopTokenStorage -• `Optional` **dpopTokenStorage**: ``"localStorage"`` \| ``"memory"`` +• `Optional` **dpopTokenStorage**: `"localStorage"` \| `"memory"` Token storage location in DPoP mode. Only meaningful when `useDpop: true`. Defaults to `'localStorage'`. #### Defined in -[packages/sdk-vue/src/types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L94) +[packages/sdk-vue/src/types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L94) -___ +--- ### loginPath @@ -74,9 +74,9 @@ The path to the login endpoint. #### Defined in -[packages/sdk-vue/src/types.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L65) +[packages/sdk-vue/src/types.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L65) -___ +--- ### logoutPath @@ -86,9 +86,9 @@ The path to the logout endpoint. #### Defined in -[packages/sdk-vue/src/types.ts:69](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L69) +[packages/sdk-vue/src/types.ts:69](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L69) -___ +--- ### mePath @@ -98,13 +98,13 @@ The path to the me endpoint. #### Defined in -[packages/sdk-vue/src/types.ts:81](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L81) +[packages/sdk-vue/src/types.ts:81](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L81) -___ +--- ### nuxtUseCookie -• `Optional` **nuxtUseCookie**: \(`name`: `string`, `_opts?`: `CookieOptions`\<`T`\> & \{ `readonly?`: ``false`` }) => `CookieRef`\<`T`\>\(`name`: `string`, `_opts`: `CookieOptions`\<`T`\> & \{ `readonly`: ``true`` }) => `Readonly`\<`CookieRef`\<`T`\>\> +• `Optional` **nuxtUseCookie**: \(`name`: `string`, `_opts?`: `CookieOptions`\<`T`\> & \{ `readonly?`: `false` }) => `CookieRef`\<`T`\>\(`name`: `string`, `_opts`: `CookieOptions`\<`T`\> & \{ `readonly`: `true` }) => `Readonly`\<`CookieRef`\<`T`\>\> Pass in `useCookie` from nuxt/app [useCookie](https://nuxt.com/docs/api/composables/use-cookie). This is needed for the Vue SDK to support Nuxt/SSR. @@ -115,16 +115,16 @@ This is needed for the Vue SDK to support Nuxt/SSR. ##### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | `undefined` \| ``null`` \| `string` | +| Name | Type | +| :--- | :-------------------------------- | +| `T` | `undefined` \| `null` \| `string` | ##### Parameters -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `_opts?` | `CookieOptions`\<`T`\> & \{ `readonly?`: ``false`` } | +| Name | Type | +| :------- | :------------------------------------------------- | +| `name` | `string` | +| `_opts?` | `CookieOptions`\<`T`\> & \{ `readonly?`: `false` } | ##### Returns @@ -134,16 +134,16 @@ This is needed for the Vue SDK to support Nuxt/SSR. ##### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | `undefined` \| ``null`` \| `string` | +| Name | Type | +| :--- | :-------------------------------- | +| `T` | `undefined` \| `null` \| `string` | ##### Parameters -| Name | Type | -| :------ | :------ | -| `name` | `string` | -| `_opts` | `CookieOptions`\<`T`\> & \{ `readonly`: ``true`` } | +| Name | Type | +| :------ | :----------------------------------------------- | +| `name` | `string` | +| `_opts` | `CookieOptions`\<`T`\> & \{ `readonly`: `true` } | ##### Returns @@ -151,9 +151,9 @@ This is needed for the Vue SDK to support Nuxt/SSR. #### Defined in -[packages/sdk-vue/src/types.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L60) +[packages/sdk-vue/src/types.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L60) -___ +--- ### onAutoRefreshFailure @@ -167,7 +167,7 @@ Callback to be invoked if a request to refresh the access token fails during aut ##### Parameters -| Name | Type | +| Name | Type | | :------ | :------ | | `error` | `Error` | @@ -177,9 +177,9 @@ Callback to be invoked if a request to refresh the access token fails during aut #### Defined in -[packages/sdk-vue/src/types.ts:54](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L54) +[packages/sdk-vue/src/types.ts:54](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L54) -___ +--- ### onRedirect @@ -193,8 +193,8 @@ Callback function to be invoked with the `state` value upon redirect from login ##### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------- | :------- | | `state?` | `string` | ##### Returns @@ -203,9 +203,9 @@ Callback function to be invoked with the `state` value upon redirect from login #### Defined in -[packages/sdk-vue/src/types.ts:49](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L49) +[packages/sdk-vue/src/types.ts:49](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L49) -___ +--- ### postLogoutRedirectUri @@ -215,9 +215,9 @@ The redirect URI for post-logout. Defaults the provided `redirectUri`. #### Defined in -[packages/sdk-vue/src/types.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L24) +[packages/sdk-vue/src/types.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L24) -___ +--- ### redirectUri @@ -227,9 +227,9 @@ The redirect URI of the application. #### Defined in -[packages/sdk-vue/src/types.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L19) +[packages/sdk-vue/src/types.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L19) -___ +--- ### registerPath @@ -239,9 +239,9 @@ The path to the register endpoint. #### Defined in -[packages/sdk-vue/src/types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L73) +[packages/sdk-vue/src/types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L73) -___ +--- ### scope @@ -251,9 +251,9 @@ The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not sp #### Defined in -[packages/sdk-vue/src/types.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L29) +[packages/sdk-vue/src/types.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L29) -___ +--- ### serverUrl @@ -263,9 +263,9 @@ The URL of the FusionAuth server. #### Defined in -[packages/sdk-vue/src/types.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L11) +[packages/sdk-vue/src/types.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L11) -___ +--- ### shouldAutoFetchUserInfo @@ -275,9 +275,9 @@ Enables the SDK to automatically handle fetching user info when logged in. Defau #### Defined in -[packages/sdk-vue/src/types.ts:39](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L39) +[packages/sdk-vue/src/types.ts:39](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L39) -___ +--- ### shouldAutoRefresh @@ -287,9 +287,9 @@ Enables automatic token refreshing. Defaults to false. #### Defined in -[packages/sdk-vue/src/types.ts:34](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L34) +[packages/sdk-vue/src/types.ts:34](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L34) -___ +--- ### tokenRefreshPath @@ -299,9 +299,9 @@ The path to the token refresh endpoint. #### Defined in -[packages/sdk-vue/src/types.ts:77](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L77) +[packages/sdk-vue/src/types.ts:77](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L77) -___ +--- ### useDpop @@ -313,4 +313,4 @@ relying on the Hosted Backend's HttpOnly cookies. Defaults to `false`. #### Defined in -[packages/sdk-vue/src/types.ts:88](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L88) +[packages/sdk-vue/src/types.ts:88](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L88) diff --git a/packages/sdk-vue/docs/interfaces/UserInfo.md b/packages/sdk-vue/docs/interfaces/UserInfo.md index 11226a3..69f8223 100644 --- a/packages/sdk-vue/docs/interfaces/UserInfo.md +++ b/packages/sdk-vue/docs/interfaces/UserInfo.md @@ -32,9 +32,9 @@ User information returned from FusionAuth. #### Defined in -[packages/sdk-vue/src/types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L101) +[packages/sdk-vue/src/types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L101) -___ +--- ### birthdate @@ -42,9 +42,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L102) +[packages/sdk-vue/src/types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L102) -___ +--- ### email @@ -52,9 +52,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L103) +[packages/sdk-vue/src/types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L103) -___ +--- ### email\_verified @@ -62,9 +62,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:104](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L104) +[packages/sdk-vue/src/types.ts:104](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L104) -___ +--- ### family\_name @@ -72,9 +72,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:105](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L105) +[packages/sdk-vue/src/types.ts:105](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L105) -___ +--- ### given\_name @@ -82,9 +82,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:106](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L106) +[packages/sdk-vue/src/types.ts:106](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L106) -___ +--- ### middle\_name @@ -92,9 +92,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:108](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L108) +[packages/sdk-vue/src/types.ts:108](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L108) -___ +--- ### name @@ -102,9 +102,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:107](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L107) +[packages/sdk-vue/src/types.ts:107](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L107) -___ +--- ### phone\_number @@ -112,9 +112,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:109](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L109) +[packages/sdk-vue/src/types.ts:109](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L109) -___ +--- ### picture @@ -122,9 +122,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:110](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L110) +[packages/sdk-vue/src/types.ts:110](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L110) -___ +--- ### preferred\_username @@ -132,9 +132,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:111](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L111) +[packages/sdk-vue/src/types.ts:111](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L111) -___ +--- ### roles @@ -142,9 +142,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:112](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L112) +[packages/sdk-vue/src/types.ts:112](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L112) -___ +--- ### sid @@ -152,9 +152,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:113](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L113) +[packages/sdk-vue/src/types.ts:113](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L113) -___ +--- ### sub @@ -162,9 +162,9 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:114](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L114) +[packages/sdk-vue/src/types.ts:114](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L114) -___ +--- ### tid @@ -172,4 +172,4 @@ ___ #### Defined in -[packages/sdk-vue/src/types.ts:115](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/types.ts#L115) +[packages/sdk-vue/src/types.ts:115](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/types.ts#L115) diff --git a/packages/sdk-vue/docs/modules.md b/packages/sdk-vue/docs/modules.md index a61e9e4..0f8aa3a 100644 --- a/packages/sdk-vue/docs/modules.md +++ b/packages/sdk-vue/docs/modules.md @@ -38,31 +38,31 @@ Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) -___ +--- ### FusionAuthLogoutButton Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) -___ +--- ### FusionAuthRegisterButton Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) -___ +--- ### RequireAnonymous Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) -___ +--- ### RequireAuth Renames and re-exports [FusionAuthLoginButton](modules/FusionAuthLoginButton.md) -___ +--- ### fusionAuthKey @@ -70,9 +70,9 @@ ___ #### Defined in -[packages/sdk-vue/src/injectionSymbols.ts:1](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/injectionSymbols.ts#L1) +[packages/sdk-vue/src/injectionSymbols.ts:1](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/injectionSymbols.ts#L1) -___ +--- ### createFusionAuth @@ -80,14 +80,14 @@ ___ #### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | [`UserInfo`](interfaces/UserInfo.md) | +| Name | Type | +| :--- | :----------------------------------- | +| `T` | [`UserInfo`](interfaces/UserInfo.md) | #### Parameters -| Name | Type | -| :------ | :------ | +| Name | Type | +| :------- | :--------------------------------------------------- | | `config` | [`FusionAuthConfig`](interfaces/FusionAuthConfig.md) | #### Returns @@ -96,9 +96,9 @@ ___ #### Defined in -[packages/sdk-vue/src/createFusionAuth/createFusionAuth.ts:7](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/createFusionAuth/createFusionAuth.ts#L7) +[packages/sdk-vue/src/createFusionAuth/createFusionAuth.ts:7](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/createFusionAuth/createFusionAuth.ts#L7) -___ +--- ### useFusionAuth @@ -106,9 +106,9 @@ ___ #### Type parameters -| Name | Type | -| :------ | :------ | -| `T` | [`UserInfo`](interfaces/UserInfo.md) | +| Name | Type | +| :--- | :----------------------------------- | +| `T` | [`UserInfo`](interfaces/UserInfo.md) | #### Returns @@ -116,7 +116,7 @@ ___ #### Defined in -[packages/sdk-vue/src/composables/useFusionAuth.ts:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/composables/useFusionAuth.ts#L5) +[packages/sdk-vue/src/composables/useFusionAuth.ts:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/composables/useFusionAuth.ts#L5) ## Plugin @@ -140,10 +140,10 @@ Will throw an error if the required options are missing. #### Type declaration -| Name | Type | -| :------ | :------ | +| Name | Type | +| :-------- | :----------------------------------------------------------------------------------------------------------------------------- | | `install` | (`app`: `App`\<`any`\>, `options`: [`FusionAuthConfig`](interfaces/FusionAuthConfig.md) \| `FusionAuthInstantiated`) => `void` | #### Defined in -[packages/sdk-vue/src/FusionAuthVuePlugin.ts:17](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/dba3da8fa07e64330f04ccfd6802d21dc1f1547a/packages/sdk-vue/src/FusionAuthVuePlugin.ts#L17) +[packages/sdk-vue/src/FusionAuthVuePlugin.ts:17](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-vue/src/FusionAuthVuePlugin.ts#L17) From 4d6b777cb092fd434113cb85968f5ada1b301515 Mon Sep 17 00:00:00 2001 From: Mike Rudat Date: Sun, 2 Aug 2026 13:34:09 -0600 Subject: [PATCH 04/10] feat: update docs using `yarn docs` and `prettier --write docs` in each packages subdirectory. --- packages/sdk-angular/docs/README.md | 2 +- .../FusionAuthAccountButtonComponent.md | 6 +- .../classes/FusionAuthLoginButtonComponent.md | 8 +- .../FusionAuthLogoutButtonComponent.md | 6 +- .../docs/classes/FusionAuthModule.md | 4 +- .../FusionAuthRegisterButtonComponent.md | 8 +- .../docs/classes/FusionAuthService.md | 32 ++--- .../docs/interfaces/FusionAuthConfig.md | 34 +++--- .../sdk-angular/docs/interfaces/UserInfo.md | 32 ++--- packages/sdk-react/docs/README.md | 59 +++++---- ...ProviderConfig.FusionAuthProviderConfig.md | 40 +++--- ...oviderContext.FusionAuthProviderContext.md | 28 ++--- .../modules/providers_FusionAuthProvider.md | 4 +- .../docs/modules/ui_FusionAuthLoginButton.md | 2 +- .../docs/modules/ui_FusionAuthLogoutButton.md | 2 +- .../modules/ui_FusionAuthRegisterButton.md | 2 +- .../sdk-react/docs/modules/ui_RequireAuth.md | 2 +- .../docs/modules/ui_Unauthenticated.md | 2 +- packages/sdk-vue/docs/README.md | 115 +++++++++--------- .../sdk-vue/docs/interfaces/FusionAuth.md | 28 ++--- .../docs/interfaces/FusionAuthConfig.md | 36 +++--- packages/sdk-vue/docs/interfaces/UserInfo.md | 30 ++--- packages/sdk-vue/docs/modules.md | 8 +- 23 files changed, 249 insertions(+), 241 deletions(-) diff --git a/packages/sdk-angular/docs/README.md b/packages/sdk-angular/docs/README.md index 92311f2..b69928d 100644 --- a/packages/sdk-angular/docs/README.md +++ b/packages/sdk-angular/docs/README.md @@ -1,6 +1,6 @@ **@fusionauth/angular-sdk** -*** +--- # FusionauthAngularSdk diff --git a/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md index 88f0117..ac3c660 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthAccountButtonComponent.md @@ -6,7 +6,7 @@ # Class: FusionAuthAccountButtonComponent -Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L10) +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L10) ## Constructors @@ -16,7 +16,7 @@ Defined in: [components/fusionauth-account.button/fusion-auth-account-button.com new FusionAuthAccountButtonComponent(fusionAuth): FusionAuthAccountButtonComponent; ``` -Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L11) +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L11) #### Parameters @@ -36,7 +36,7 @@ Defined in: [components/fusionauth-account.button/fusion-auth-account-button.com manageAccount(): void; ``` -Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L13) +Defined in: [components/fusionauth-account.button/fusion-auth-account-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-account.button/fusion-auth-account-button.component.ts#L13) #### Returns diff --git a/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md index 7d52d47..d9d2cc1 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthLoginButtonComponent.md @@ -6,7 +6,7 @@ # Class: FusionAuthLoginButtonComponent -Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L10) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L10) ## Constructors @@ -16,7 +16,7 @@ Defined in: [components/fusionauth-login.button/fusion-auth-login-button.compone new FusionAuthLoginButtonComponent(fusionAuth): FusionAuthLoginButtonComponent; ``` -Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L13) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L13) #### Parameters @@ -36,7 +36,7 @@ Defined in: [components/fusionauth-login.button/fusion-auth-login-button.compone state: string | undefined; ``` -Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L11) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:11](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L11) ## Methods @@ -46,7 +46,7 @@ Defined in: [components/fusionauth-login.button/fusion-auth-login-button.compone login(): void; ``` -Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L15) +Defined in: [components/fusionauth-login.button/fusion-auth-login-button.component.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-login.button/fusion-auth-login-button.component.ts#L15) #### Returns diff --git a/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md index 0fd350c..f90ac10 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthLogoutButtonComponent.md @@ -6,7 +6,7 @@ # Class: FusionAuthLogoutButtonComponent -Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L13) +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L13) ## Constructors @@ -16,7 +16,7 @@ Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.compo new FusionAuthLogoutButtonComponent(fusionAuth): FusionAuthLogoutButtonComponent; ``` -Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L14) +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L14) #### Parameters @@ -36,7 +36,7 @@ Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.compo logout(): void; ``` -Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L16) +Defined in: [components/fusionauth-logout.button/fusion-auth-logout-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-logout.button/fusion-auth-logout-button.component.ts#L16) #### Returns diff --git a/packages/sdk-angular/docs/classes/FusionAuthModule.md b/packages/sdk-angular/docs/classes/FusionAuthModule.md index e30ff56..95ef366 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthModule.md +++ b/packages/sdk-angular/docs/classes/FusionAuthModule.md @@ -6,7 +6,7 @@ # Class: FusionAuthModule -Defined in: [fusion-auth.module.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L25) +Defined in: [fusion-auth.module.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L25) ## Constructors @@ -28,7 +28,7 @@ new FusionAuthModule(): FusionAuthModule; static forRoot(fusionAuthConfig): ModuleWithProviders; ``` -Defined in: [fusion-auth.module.ts:26](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L26) +Defined in: [fusion-auth.module.ts:26](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.module.ts#L26) #### Parameters diff --git a/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md b/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md index 3720b0d..fcbe5f7 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md +++ b/packages/sdk-angular/docs/classes/FusionAuthRegisterButtonComponent.md @@ -6,7 +6,7 @@ # Class: FusionAuthRegisterButtonComponent -Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L13) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L13) ## Constructors @@ -16,7 +16,7 @@ Defined in: [components/fusionauth-register.button/fusion-auth-register-button.c new FusionAuthRegisterButtonComponent(fusionAuth): FusionAuthRegisterButtonComponent; ``` -Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L16) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L16) #### Parameters @@ -36,7 +36,7 @@ Defined in: [components/fusionauth-register.button/fusion-auth-register-button.c state: string | undefined; ``` -Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L14) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:14](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L14) ## Methods @@ -46,7 +46,7 @@ Defined in: [components/fusionauth-register.button/fusion-auth-register-button.c register(): void; ``` -Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L18) +Defined in: [components/fusionauth-register.button/fusion-auth-register-button.component.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/components/fusionauth-register.button/fusion-auth-register-button.component.ts#L18) #### Returns diff --git a/packages/sdk-angular/docs/classes/FusionAuthService.md b/packages/sdk-angular/docs/classes/FusionAuthService.md index d0d2558..a928b44 100644 --- a/packages/sdk-angular/docs/classes/FusionAuthService.md +++ b/packages/sdk-angular/docs/classes/FusionAuthService.md @@ -6,7 +6,7 @@ # Class: FusionAuthService\ -Defined in: [fusion-auth.service.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L24) +Defined in: [fusion-auth.service.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L24) Service class to use with FusionAuth backend endpoints. @@ -28,7 +28,7 @@ new FusionAuthService( appRef): FusionAuthService; ``` -Defined in: [fusion-auth.service.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L29) +Defined in: [fusion-auth.service.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L29) #### Parameters @@ -60,7 +60,7 @@ Defined in: [fusion-auth.service.ts:29](https://github.com/FusionAuth/fusionauth isLoggedIn$: Observable; ``` -Defined in: [fusion-auth.service.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L68) +Defined in: [fusion-auth.service.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L68) An observable representing whether the user is logged in. @@ -72,7 +72,7 @@ An observable representing whether the user is logged in. isLoggedInSignal: Signal; ``` -Defined in: [fusion-auth.service.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L73) +Defined in: [fusion-auth.service.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L73) A Signal representing whether the user is logged in. @@ -84,7 +84,7 @@ A Signal representing whether the user is logged in. dpopFetch(input, init?): Promise; ``` -Defined in: [fusion-auth.service.ts:177](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L177) +Defined in: [fusion-auth.service.ts:177](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L177) DPoP mode `fetch()` wrapper that automatically attaches DPoP proof headers. @@ -119,7 +119,7 @@ generateProof( nonce?): Promise; ``` -Defined in: [fusion-auth.service.ts:189](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L189) +Defined in: [fusion-auth.service.ts:189](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L189) Returns a signed DPoP proof JWT for use with axios or other HTTP libraries that can't use [dpopFetch](#dpopfetch). @@ -158,7 +158,7 @@ if called when `useDpop` is not enabled. getAccessToken(): string | null; ``` -Defined in: [fusion-auth.service.ts:202](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L202) +Defined in: [fusion-auth.service.ts:202](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L202) Returns the stored DPoP access token, or `null` if not logged in. @@ -178,7 +178,7 @@ if called when `useDpop` is not enabled. getUserInfo(): Promise; ``` -Defined in: [fusion-auth.service.ts:131](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L131) +Defined in: [fusion-auth.service.ts:131](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L131) Fetches userInfo from the 'me' endpoint. @@ -204,7 +204,7 @@ Fetches userInfo from the 'me' endpoint. getUserInfoObservable(callbacks?): Observable; ``` -Defined in: [fusion-auth.service.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L103) +Defined in: [fusion-auth.service.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L103) Returns an observable request that fetches userInfo, and catches error. @@ -232,7 +232,7 @@ Returns an observable request that fetches userInfo, and catches error. initAutoRefresh(): void; ``` -Defined in: [fusion-auth.service.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L92) +Defined in: [fusion-auth.service.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L92) Initializes automatic access token refreshing. This is handled automatically if the SDK is configured with `shouldAutoRefresh`. @@ -249,7 +249,7 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. isLoggedIn(): boolean; ``` -Defined in: [fusion-auth.service.ts:76](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L76) +Defined in: [fusion-auth.service.ts:76](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L76) A function that returns whether the user is logged in. This returned value is non-observable. @@ -265,7 +265,7 @@ A function that returns whether the user is logged in. This returned value is no logout(): void; ``` -Defined in: [fusion-auth.service.ts:160](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L160) +Defined in: [fusion-auth.service.ts:160](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L160) Initiates logout flow. @@ -281,7 +281,7 @@ Initiates logout flow. manageAccount(): void; ``` -Defined in: [fusion-auth.service.ts:168](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L168) +Defined in: [fusion-auth.service.ts:168](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L168) Redirects to [self service account management](https://fusionauth.io/docs/lifecycle/manage-users/account-management/) Self service account management is only available in FusionAuth paid plans. @@ -298,7 +298,7 @@ Self service account management is only available in FusionAuth paid plans. refreshToken(): Promise; ``` -Defined in: [fusion-auth.service.ts:84](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L84) +Defined in: [fusion-auth.service.ts:84](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L84) Refreshes the access token a single time. Automatic token refreshing can be enabled if the SDK is configured with `shouldAutoRefresh`. @@ -315,7 +315,7 @@ Automatic token refreshing can be enabled if the SDK is configured with `shouldA startLogin(state?): void; ``` -Defined in: [fusion-auth.service.ts:145](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L145) +Defined in: [fusion-auth.service.ts:145](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L145) Initiates login flow. @@ -339,7 +339,7 @@ Optional value to be echoed back to the SDK upon redirect. startRegistration(state?): void; ``` -Defined in: [fusion-auth.service.ts:153](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L153) +Defined in: [fusion-auth.service.ts:153](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/fusion-auth.service.ts#L153) Initiates register flow. diff --git a/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md b/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md index 6521f55..bc1ca22 100644 --- a/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md +++ b/packages/sdk-angular/docs/interfaces/FusionAuthConfig.md @@ -6,7 +6,7 @@ # Interface: FusionAuthConfig -Defined in: [types.ts:4](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L4) +Defined in: [types.ts:4](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L4) Config for FusionAuth Angular SDK @@ -18,7 +18,7 @@ Config for FusionAuth Angular SDK optional autoRefreshSecondsBeforeExpiry?: number; ``` -Defined in: [types.ts:38](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L38) +Defined in: [types.ts:38](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L38) The number of seconds before the access token expiry when the auto refresh functionality kicks in if enabled. Default is 10. @@ -30,7 +30,7 @@ The number of seconds before the access token expiry when the auto refresh funct clientId: string; ``` -Defined in: [types.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L13) +Defined in: [types.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L13) The client id of the application. @@ -42,7 +42,7 @@ The client id of the application. optional dpopTokenStorage?: "localStorage" | "memory"; ``` -Defined in: [types.ts:86](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L86) +Defined in: [types.ts:86](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L86) Token storage location in DPoP mode. Only meaningful when `useDpop: true`. Defaults to `'localStorage'`. @@ -55,7 +55,7 @@ Defaults to `'localStorage'`. optional loginPath?: string; ``` -Defined in: [types.ts:53](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L53) +Defined in: [types.ts:53](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L53) The path to the login endpoint. @@ -67,7 +67,7 @@ The path to the login endpoint. optional logoutPath?: string; ``` -Defined in: [types.ts:63](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L63) +Defined in: [types.ts:63](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L63) The path to the logout endpoint. @@ -79,7 +79,7 @@ The path to the logout endpoint. optional mePath?: string; ``` -Defined in: [types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L73) +Defined in: [types.ts:73](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L73) The path to the me endpoint. @@ -91,7 +91,7 @@ The path to the me endpoint. optional onAutoRefreshFailure?: (error) => void; ``` -Defined in: [types.ts:48](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L48) +Defined in: [types.ts:48](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L48) Callback to be invoked if a request to refresh the access token fails during autorefresh. @@ -113,7 +113,7 @@ Callback to be invoked if a request to refresh the access token fails during aut optional onRedirect?: (state?) => void; ``` -Defined in: [types.ts:43](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L43) +Defined in: [types.ts:43](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L43) Callback function to be invoked with the `state` value upon redirect from login or register. @@ -135,7 +135,7 @@ Callback function to be invoked with the `state` value upon redirect from login optional postLogoutRedirectUri?: string; ``` -Defined in: [types.ts:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L23) +Defined in: [types.ts:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L23) The redirect URI for post-logout. Defaults the provided `redirectUri`. @@ -147,7 +147,7 @@ The redirect URI for post-logout. Defaults the provided `redirectUri`. redirectUri: string; ``` -Defined in: [types.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L18) +Defined in: [types.ts:18](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L18) The redirect URI of the application. @@ -159,7 +159,7 @@ The redirect URI of the application. optional registerPath?: string; ``` -Defined in: [types.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L58) +Defined in: [types.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L58) The path to the register endpoint. @@ -171,7 +171,7 @@ The path to the register endpoint. optional scope?: string; ``` -Defined in: [types.ts:28](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L28) +Defined in: [types.ts:28](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L28) The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not specified fusionauth will default this to `openid offline_access`. @@ -183,7 +183,7 @@ The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not sp serverUrl: string; ``` -Defined in: [types.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L8) +Defined in: [types.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L8) The URL of the server that performs the token exchange. @@ -195,7 +195,7 @@ The URL of the server that performs the token exchange. optional shouldAutoRefresh?: boolean; ``` -Defined in: [types.ts:33](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L33) +Defined in: [types.ts:33](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L33) Enables automatic token refreshing. Defaults to false. @@ -207,7 +207,7 @@ Enables automatic token refreshing. Defaults to false. optional tokenRefreshPath?: string; ``` -Defined in: [types.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L68) +Defined in: [types.ts:68](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L68) The path to the token refresh endpoint. @@ -219,7 +219,7 @@ The path to the token refresh endpoint. optional useDpop?: boolean; ``` -Defined in: [types.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L80) +Defined in: [types.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L80) Opt-in to DPoP mode. When `true`, the SDK calls FusionAuth endpoints directly and stores tokens in JavaScript-accessible storage instead of diff --git a/packages/sdk-angular/docs/interfaces/UserInfo.md b/packages/sdk-angular/docs/interfaces/UserInfo.md index edf5045..e56dd78 100644 --- a/packages/sdk-angular/docs/interfaces/UserInfo.md +++ b/packages/sdk-angular/docs/interfaces/UserInfo.md @@ -6,7 +6,7 @@ # Interface: UserInfo -Defined in: [types.ts:89](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L89) +Defined in: [types.ts:89](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L89) ## Properties @@ -16,7 +16,7 @@ Defined in: [types.ts:89](https://github.com/FusionAuth/fusionauth-javascript-sd optional applicationId?: string; ``` -Defined in: [types.ts:90](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L90) +Defined in: [types.ts:90](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L90) --- @@ -26,7 +26,7 @@ Defined in: [types.ts:90](https://github.com/FusionAuth/fusionauth-javascript-sd optional birthdate?: string; ``` -Defined in: [types.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L91) +Defined in: [types.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L91) --- @@ -36,7 +36,7 @@ Defined in: [types.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sd optional email?: string; ``` -Defined in: [types.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L92) +Defined in: [types.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L92) --- @@ -46,7 +46,7 @@ Defined in: [types.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sd optional email_verified?: boolean; ``` -Defined in: [types.ts:93](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L93) +Defined in: [types.ts:93](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L93) --- @@ -56,7 +56,7 @@ Defined in: [types.ts:93](https://github.com/FusionAuth/fusionauth-javascript-sd optional family_name?: string; ``` -Defined in: [types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L94) +Defined in: [types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L94) --- @@ -66,7 +66,7 @@ Defined in: [types.ts:94](https://github.com/FusionAuth/fusionauth-javascript-sd optional given_name?: string; ``` -Defined in: [types.ts:95](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L95) +Defined in: [types.ts:95](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L95) --- @@ -76,7 +76,7 @@ Defined in: [types.ts:95](https://github.com/FusionAuth/fusionauth-javascript-sd optional middle_name?: string; ``` -Defined in: [types.ts:96](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L96) +Defined in: [types.ts:96](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L96) --- @@ -86,7 +86,7 @@ Defined in: [types.ts:96](https://github.com/FusionAuth/fusionauth-javascript-sd optional name?: string; ``` -Defined in: [types.ts:97](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L97) +Defined in: [types.ts:97](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L97) --- @@ -96,7 +96,7 @@ Defined in: [types.ts:97](https://github.com/FusionAuth/fusionauth-javascript-sd optional phone_number?: string; ``` -Defined in: [types.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L98) +Defined in: [types.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L98) --- @@ -106,7 +106,7 @@ Defined in: [types.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sd optional picture?: string; ``` -Defined in: [types.ts:99](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L99) +Defined in: [types.ts:99](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L99) --- @@ -116,7 +116,7 @@ Defined in: [types.ts:99](https://github.com/FusionAuth/fusionauth-javascript-sd optional preferred_username?: string; ``` -Defined in: [types.ts:100](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L100) +Defined in: [types.ts:100](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L100) --- @@ -126,7 +126,7 @@ Defined in: [types.ts:100](https://github.com/FusionAuth/fusionauth-javascript-s optional roles?: any[]; ``` -Defined in: [types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L101) +Defined in: [types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L101) --- @@ -136,7 +136,7 @@ Defined in: [types.ts:101](https://github.com/FusionAuth/fusionauth-javascript-s optional sid?: string; ``` -Defined in: [types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L102) +Defined in: [types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L102) --- @@ -146,7 +146,7 @@ Defined in: [types.ts:102](https://github.com/FusionAuth/fusionauth-javascript-s optional sub?: string; ``` -Defined in: [types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L103) +Defined in: [types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L103) --- @@ -156,4 +156,4 @@ Defined in: [types.ts:103](https://github.com/FusionAuth/fusionauth-javascript-s optional tid?: string; ``` -Defined in: [types.ts:104](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L104) +Defined in: [types.ts:104](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-angular/projects/fusionauth-angular-sdk/src/lib/types.ts#L104) diff --git a/packages/sdk-react/docs/README.md b/packages/sdk-react/docs/README.md index 5367218..58dada2 100644 --- a/packages/sdk-react/docs/README.md +++ b/packages/sdk-react/docs/README.md @@ -11,12 +11,12 @@ An SDK for using FusionAuth in React applications. - [Configuration](#configuration) - [Configuration with NextJS](#configuration-with-nextjs) - [Usage](#usage) - - [useFusionAuth](#usefusionauth) - - [State Parameter](#state-parameter) - - [Protecting content](#protecting-content) - - [UI Components](#ui-components) - - [DPoP Mode](#dpop-mode) - - [Resource Server Guidance](#resource-server-guidance) + - [useFusionAuth](#usefusionauth) + - [State Parameter](#state-parameter) + - [Protecting content](#protecting-content) + - [UI Components](#ui-components) + - [DPoP Mode](#dpop-mode) + - [Resource Server Guidance](#resource-server-guidance) - [Known issues](#known-issues) - [Documentation](#documentation) - [Formatting](#formatting) @@ -43,18 +43,19 @@ then log in. After that, they are sent back to your React application. Once authentication succeeds, the following secure, HTTP-only cookies will be set: -- `app.at` - an OAuth [Access - Token](https://fusionauth.io/docs/v1/tech/oauth/tokens#access-token) +- `app.at` - an OAuth [Access + Token](https://fusionauth.io/docs/v1/tech/oauth/tokens#access-token) -- `app.rt` - a [Refresh - Token](https://fusionauth.io/docs/v1/tech/oauth/tokens#refresh-token) - used to obtain a new `app.at`. This cookie will only be set if - refresh tokens are enabled on your FusionAuth instance. +- `app.rt` - a [Refresh + Token](https://fusionauth.io/docs/v1/tech/oauth/tokens#refresh-token) + used to obtain a new `app.at`. This cookie will only be set if + refresh tokens are enabled on your FusionAuth instance. The access token can be presented to APIs to authorize the request and the refresh token can be used to get a new access token. There are 2 ways to interact with this SDK: + 1. By hosting your own server that performs the OAuth token exchange and meets the [server code requirements for FusionAuth Web SDKs](https://github.com/FusionAuth/fusionauth-javascript-sdk-express#server-code-requirements). 2. By using the server hosted on your FusionAuth instance, i.e., not writing your own server code. @@ -115,7 +116,7 @@ ReactDOM.createRoot(document.getElementById("my-app")).render( To configure the SDK with Next, install [`next-client-cookies`](https://github.com/moshest/next-client-cookies?tab=readme-ov-file#install) and pass `useCookies` into the config object as `nextCookieAdapter`. ```jsx -'use client' +'use client'; import { useCookies } from 'next-client-cookies'; @@ -147,11 +148,11 @@ function MyComponent() { isFetchingUserInfo, startLogin, startRegister, - userInfo - } = useFusionAuth() + userInfo, + } = useFusionAuth(); if (isFetchingUserInfo) { - return

Loading...

+ return

Loading...

; } if (!isLoggedIn) { @@ -165,7 +166,7 @@ function MyComponent() { } if (userInfo?.given_name) { - return

Welcome {userInfo.given_name}!

+ return

Welcome {userInfo.given_name}!

; } } ``` @@ -189,9 +190,10 @@ const UserNameDisplay = () => { return ( <> -

User: {userInfo.given_name}

// Only displays if user is authenticated +

User: {userInfo.given_name}

// Only displays if user is + authenticated - +

Please log in to view this page

 @@ -201,7 +203,8 @@ const UserNameDisplay = () => { const AdminPanel = () => ( - // Only displays if user is authenticated and has 'admin' role + // Only displays if user is authenticated and + has 'admin' role ); ``` @@ -214,7 +217,7 @@ This SDK offers 3 pre-built UI components. import { FusionAuthLoginButton, FusionAuthLogoutButton, - FusionAuthRegisterButton + FusionAuthRegisterButton, } from '@fusionauth/react-sdk'; export const LoginPage = () => ( @@ -253,11 +256,17 @@ When `useDpop: true`, `useFusionAuth()` additionally returns `dpopFetch`, `gener const { dpopFetch, generateProof, getAccessToken } = useFusionAuth(); // Recommended — handles attaching DPoP headers (and nonce retries) automatically. -const response = await dpopFetch('https://api.example.com/data', { method: 'GET' }); +const response = await dpopFetch('https://api.example.com/data', { + method: 'GET', +}); // Advanced — for axios or other HTTP libraries that can't use dpopFetch. const accessToken = getAccessToken(); -const proof = await generateProof('https://api.example.com/data', 'GET', accessToken); +const proof = await generateProof( + 'https://api.example.com/data', + 'GET', + accessToken, +); // axios.get('https://api.example.com/data', { // headers: { Authorization: `DPoP ${accessToken}`, DPoP: proof } // }); @@ -291,8 +300,8 @@ end::forDocSite[] There are several linting packages run when you push to a branch. One is `prettier`. If this fails, you can fix the files from the command line: -* npm run install -* npm run prettier -- -w /path/to/file +- npm run install +- npm run prettier -- -w /path/to/file Doing this will overwrite your file, but fix prettier's objections. diff --git a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md index 986e8eb..7173226 100644 --- a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md +++ b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderConfig.FusionAuthProviderConfig.md @@ -42,7 +42,7 @@ Only set this if you are hosting server that uses a custom name for the 'app.at_ #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L98) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:98](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L98) --- @@ -54,7 +54,7 @@ Additional params passed to loginPath typically `/app/login/`, which redirects t #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:30](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L30) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:30](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L30) --- @@ -66,7 +66,7 @@ The number of seconds before the access token expiry when the auto refresh funct #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:50](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L50) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:50](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L50) --- @@ -78,7 +78,7 @@ The client id of the application. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L15) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L15) --- @@ -91,7 +91,7 @@ Defaults to `'localStorage'`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:111](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L111) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:111](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L111) --- @@ -103,7 +103,7 @@ The path to the login endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L65) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:65](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L65) --- @@ -115,7 +115,7 @@ The path to the logout endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:75](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L75) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:75](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L75) --- @@ -127,7 +127,7 @@ The path to the me endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L92) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:92](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L92) --- @@ -149,7 +149,7 @@ See docs for [configuration with nextjs](https://github.com/FusionAuth/fusionaut #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:87](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L87) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:87](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L87) --- @@ -175,7 +175,7 @@ Callback to be invoked if a request to refresh the access token fails during aut #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L60) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:60](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L60) --- @@ -201,7 +201,7 @@ Callback function to be invoked with the `state` value upon redirect from login #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:55](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L55) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:55](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L55) --- @@ -213,7 +213,7 @@ The redirect URI for post-logout. Defaults the provided `redirectUri`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L35) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L35) --- @@ -225,7 +225,7 @@ The redirect URI of the application. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:20](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L20) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:20](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L20) --- @@ -237,7 +237,7 @@ The path to the register endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L70) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L70) --- @@ -249,7 +249,7 @@ The OAuth2 scope parameter passed to the `/oauth2/authorize` endpoint. If not sp #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L25) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:25](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L25) --- @@ -261,7 +261,7 @@ The URL of the server that performs the token exchange. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L10) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L10) --- @@ -273,7 +273,7 @@ Enables the SDK to automatically handle fetching user info when logged in. Defau #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:45](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L45) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:45](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L45) --- @@ -285,7 +285,7 @@ Enables automatic token refreshing. Defaults to false. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:40](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L40) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:40](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L40) --- @@ -297,7 +297,7 @@ The path to the token refresh endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L80) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:80](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L80) --- @@ -311,4 +311,4 @@ relying on the Hosted Backend's HttpOnly cookies. Defaults to `false`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:105](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L105) +[packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts:105](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderConfig.ts#L105) diff --git a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md index 8785d57..845ddec 100644 --- a/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md +++ b/packages/sdk-react/docs/interfaces/providers_FusionAuthProviderContext.FusionAuthProviderContext.md @@ -57,7 +57,7 @@ Present only when `useDpop: true`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L70) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:70](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L70) --- @@ -69,7 +69,7 @@ Error occurred while fetching userInfo. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L29) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:29](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L29) --- @@ -90,7 +90,7 @@ This is handled automatically if the SDK is configured with `shouldAutoFetchUser #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L19) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:19](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L19) --- @@ -120,7 +120,7 @@ HTTP libraries. Present only when `useDpop: true`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:79](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L79) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:79](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L79) --- @@ -142,7 +142,7 @@ Present only when `useDpop: true`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L91) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:91](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L91) --- @@ -163,7 +163,7 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:64](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L64) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:64](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L64) --- @@ -175,7 +175,7 @@ Indicates that the fetchUserInfo call is unresolved. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L24) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:24](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L24) --- @@ -187,7 +187,7 @@ Whether the user is logged in. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L8) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:8](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L8) --- @@ -208,7 +208,7 @@ Self service account management is only available in FusionAuth paid plans. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:52](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L52) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:52](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L52) --- @@ -229,7 +229,7 @@ This is handled automatically if the SDK is configured with `shouldAutoRefresh`. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L58) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:58](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L58) --- @@ -255,7 +255,7 @@ Initiates login flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L35) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:35](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L35) --- @@ -275,7 +275,7 @@ Initiates logout flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:46](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L46) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:46](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L46) --- @@ -301,7 +301,7 @@ Initiates register flow. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:41](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L41) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:41](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L41) --- @@ -313,4 +313,4 @@ Data fetched from the configured 'me' endpoint. #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L13) +[packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProviderContext.ts#L13) diff --git a/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md b/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md index 5a4ee2d..d9b14cc 100644 --- a/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md +++ b/packages/sdk-react/docs/modules/providers_FusionAuthProvider.md @@ -33,7 +33,7 @@ #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L23) +[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:23](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L23) --- @@ -55,4 +55,4 @@ A hook that returns `FusionAuthProviderContext` #### Defined in -[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:155](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L155) +[packages/sdk-react/src/components/providers/FusionAuthProvider.tsx:155](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/providers/FusionAuthProvider.tsx#L155) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md index 91ac65b..8596437 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthLoginButton.md @@ -28,4 +28,4 @@ Calls the `startLogin` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx#L16) +[packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx:16](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/ui/FusionAuthLoginButton/index.tsx#L16) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md index 522ea96..9d3e703 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthLogoutButton.md @@ -28,4 +28,4 @@ Calls the `startLogout` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx#L13) +[packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx:13](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/ui/FusionAuthLogoutButton/index.tsx#L13) diff --git a/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md b/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md index 4d8847d..f59d32e 100644 --- a/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md +++ b/packages/sdk-react/docs/modules/ui_FusionAuthRegisterButton.md @@ -28,4 +28,4 @@ Calls the `startRegister` method from `FusionAuthProviderContext`. #### Defined in -[packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx#L15) +[packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx:15](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/ui/FusionAuthRegisterButton/index.tsx#L15) diff --git a/packages/sdk-react/docs/modules/ui_RequireAuth.md b/packages/sdk-react/docs/modules/ui_RequireAuth.md index 167dd16..5195858 100644 --- a/packages/sdk-react/docs/modules/ui_RequireAuth.md +++ b/packages/sdk-react/docs/modules/ui_RequireAuth.md @@ -28,4 +28,4 @@ Only renders children when user is authenticated. #### Defined in -[packages/sdk-react/src/components/ui/RequireAuth/index.tsx:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/RequireAuth/index.tsx#L10) +[packages/sdk-react/src/components/ui/RequireAuth/index.tsx:10](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/ui/RequireAuth/index.tsx#L10) diff --git a/packages/sdk-react/docs/modules/ui_Unauthenticated.md b/packages/sdk-react/docs/modules/ui_Unauthenticated.md index 1238734..3980d42 100644 --- a/packages/sdk-react/docs/modules/ui_Unauthenticated.md +++ b/packages/sdk-react/docs/modules/ui_Unauthenticated.md @@ -29,4 +29,4 @@ Only renders children when user is unauthenticated. #### Defined in -[packages/sdk-react/src/components/ui/Unauthenticated/index.tsx:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/2d9af72c9bed501cbc80b584411e66e73a4cc15c/packages/sdk-react/src/components/ui/Unauthenticated/index.tsx#L5) +[packages/sdk-react/src/components/ui/Unauthenticated/index.tsx:5](https://github.com/FusionAuth/fusionauth-javascript-sdk/blob/ee8adbc65b4bc7586f80efa86002158c90d78a7e/packages/sdk-react/src/components/ui/Unauthenticated/index.tsx#L5) diff --git a/packages/sdk-vue/docs/README.md b/packages/sdk-vue/docs/README.md index 5da1acf..0ac32e0 100644 --- a/packages/sdk-vue/docs/README.md +++ b/packages/sdk-vue/docs/README.md @@ -43,18 +43,19 @@ then log in. After that, they are sent back to your Vue application. Once authentication succeeds, the following secure, HTTP-only cookies will be set: -- `app.at` - an OAuth [Access - Token](https://fusionauth.io/docs/v1/tech/oauth/tokens#access-token) +- `app.at` - an OAuth [Access + Token](https://fusionauth.io/docs/v1/tech/oauth/tokens#access-token) -- `app.rt` - a [Refresh - Token](https://fusionauth.io/docs/v1/tech/oauth/tokens#refresh-token) - used to obtain a new `app.at`. This cookie will only be set if - refresh tokens are enabled on your FusionAuth instance. +- `app.rt` - a [Refresh + Token](https://fusionauth.io/docs/v1/tech/oauth/tokens#refresh-token) + used to obtain a new `app.at`. This cookie will only be set if + refresh tokens are enabled on your FusionAuth instance. The access token can be presented to APIs to authorize the request and the refresh token can be used to get a new access token. There are 2 ways to interact with this SDK: + 1. By hosting your own server that performs the OAuth token exchange and meets the [server code requirements for FusionAuth Web SDKs](https://github.com/FusionAuth/fusionauth-javascript-sdk-express#server-code-requirements). 2. By using the server hosted on your FusionAuth instance, i.e., not writing your own server code. @@ -93,22 +94,24 @@ Configure and initialize the `FusionAuthVuePlugin` when you create your Vue app: ```typescript import { createApp } from 'vue'; -import FusionAuthVuePlugin, { type FusionAuthConfig } from '@fusionauth/vue-sdk'; +import FusionAuthVuePlugin, { + type FusionAuthConfig, +} from '@fusionauth/vue-sdk'; const config: FusionAuthConfig = { - clientId: "", // Your app's FusionAuth client id - serverUrl: "", // The url of the server that performs the token exchange - redirectUri: "", // The URI that the user is directed to after the login/register/logout action + clientId: '', // Your app's FusionAuth client id + serverUrl: '', // The url of the server that performs the token exchange + redirectUri: '', // The URI that the user is directed to after the login/register/logout action shouldAutoFetchUserInfo: true, // Automatically fetch userInfo when logged in. Defaults to false. shouldAutoRefresh: true, // Enables automatic token refresh. Defaults to false. - onRedirect: (state?: string) => { }, // Optional callback invoked upon redirect back from login or register. + onRedirect: (state?: string) => {}, // Optional callback invoked upon redirect back from login or register. // useDpop: true, // Opt-in to DPoP mode. See "DPoP Mode" below. Defaults to false. -} +}; const app = createApp(App); app.use(FusionAuthVuePlugin, config); -app.mount('#app') +app.mount('#app'); ``` If you want to use the pre-styled buttons, don't forget to import the css file: @@ -139,13 +142,13 @@ Using `createFusionAuth`, the SDK can be configured more flexibly. ```typescript export default defineNuxtPlugin({ setup(nuxtApp) { - const fusionauth = createFusionAuth(config); - nuxtApp.vueApp.use(FusionAuthVuePlugin, { instance: fusionauth }) + const fusionauth = createFusionAuth(config); + nuxtApp.vueApp.use(FusionAuthVuePlugin, { instance: fusionauth }); return { - provide: { fusionauth } + provide: { fusionauth }, }; }, -}) +}); ``` ### `useFusionAuth` composable @@ -155,33 +158,23 @@ View the [full API documentation](https://github.com/FusionAuth/fusionauth-javas ```html