Skip to content

Commit

Permalink
chore: fix typedoc issue
Browse files Browse the repository at this point in the history
  • Loading branch information
simenandre committed Apr 21, 2023
1 parent 5441a81 commit 5e5ef61
Show file tree
Hide file tree
Showing 6 changed files with 72 additions and 53 deletions.
14 changes: 7 additions & 7 deletions docs/interfaces/AuthContextProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Auth state: True until the library has been initialized.

#### Defined in

[src/AuthContextInterface.ts:171](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L171)
[src/AuthContextInterface.ts:176](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L176)

___

Expand All @@ -50,7 +50,7 @@ Alias for userManager.signInRedirect

#### Defined in

[src/AuthContextInterface.ts:147](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L147)
[src/AuthContextInterface.ts:152](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L152)

___

Expand All @@ -70,7 +70,7 @@ Alias for userManager.signinPopup

#### Defined in

[src/AuthContextInterface.ts:151](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L151)
[src/AuthContextInterface.ts:156](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L156)

___

Expand All @@ -90,7 +90,7 @@ Alias for removeUser

#### Defined in

[src/AuthContextInterface.ts:155](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L155)
[src/AuthContextInterface.ts:160](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L160)

___

Expand All @@ -114,7 +114,7 @@ ___

#### Defined in

[src/AuthContextInterface.ts:159](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L159)
[src/AuthContextInterface.ts:164](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L164)

___

Expand All @@ -126,7 +126,7 @@ See [User](https://authts.github.io/oidc-client-ts/classes/User.html) for more d

#### Defined in

[src/AuthContextInterface.ts:167](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L167)
[src/AuthContextInterface.ts:172](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L172)

___

Expand All @@ -138,4 +138,4 @@ See [UserManager](https://authts.github.io/oidc-client-ts/classes/UserManager.ht

#### Defined in

[src/AuthContextInterface.ts:163](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L163)
[src/AuthContextInterface.ts:168](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L168)
59 changes: 36 additions & 23 deletions docs/interfaces/AuthProviderProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- [extraQueryParams](AuthProviderProps.md#extraqueryparams)
- [loadUserInfo](AuthProviderProps.md#loaduserinfo)
- [location](AuthProviderProps.md#location)
- [metadata](AuthProviderProps.md#metadata)
- [onBeforeSignIn](AuthProviderProps.md#onbeforesignin)
- [onSignIn](AuthProviderProps.md#onsignin)
- [onSignOut](AuthProviderProps.md#onsignout)
Expand All @@ -40,7 +41,7 @@ The URL of the OIDC/OAuth2 provider.

#### Defined in

[src/AuthContextInterface.ts:40](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L40)
[src/AuthContextInterface.ts:41](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L41)

___

Expand All @@ -54,7 +55,7 @@ Defaults to true.

#### Defined in

[src/AuthContextInterface.ts:84](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L84)
[src/AuthContextInterface.ts:89](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L89)

___

Expand All @@ -66,7 +67,7 @@ Optional sign in arguments to be used when `autoSignIn` is enabled.

#### Defined in

[src/AuthContextInterface.ts:88](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L88)
[src/AuthContextInterface.ts:93](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L93)

___

Expand All @@ -80,7 +81,7 @@ Defaults to true.

#### Defined in

[src/AuthContextInterface.ts:94](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L94)
[src/AuthContextInterface.ts:99](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L99)

___

Expand All @@ -92,7 +93,7 @@ Optional sign out arguments to be used when `autoSignOut` is enabled.

#### Defined in

[src/AuthContextInterface.ts:98](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L98)
[src/AuthContextInterface.ts:103](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L103)

___

Expand All @@ -106,7 +107,7 @@ Defaults to true.

#### Defined in

[src/AuthContextInterface.ts:104](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L104)
[src/AuthContextInterface.ts:109](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L109)

___

Expand All @@ -118,7 +119,7 @@ Your client application's identifier as registered with the OIDC/OAuth2 provider

#### Defined in

[src/AuthContextInterface.ts:48](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L48)
[src/AuthContextInterface.ts:53](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L53)

___

Expand All @@ -130,7 +131,7 @@ Client secret defined on the identity server.

#### Defined in

[src/AuthContextInterface.ts:52](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L52)
[src/AuthContextInterface.ts:57](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L57)

___

Expand All @@ -142,7 +143,7 @@ Extra query params passed to the authorization url.

#### Defined in

[src/AuthContextInterface.ts:44](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L44)
[src/AuthContextInterface.ts:49](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L49)

___

Expand All @@ -156,7 +157,7 @@ Defaults to true.

#### Defined in

[src/AuthContextInterface.ts:110](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L110)
[src/AuthContextInterface.ts:115](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L115)

___

Expand All @@ -168,7 +169,19 @@ Defaults to `windows.location`.

#### Defined in

[src/AuthContextInterface.ts:78](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L78)
[src/AuthContextInterface.ts:83](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L83)

___

### metadata

`Optional` **metadata**: `Partial`<`OidcMetadata`\>

Manually set metadata if CORS is not configured on the OIDC/OAuth2 provider.

#### Defined in

[src/AuthContextInterface.ts:45](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L45)

___

Expand All @@ -190,7 +203,7 @@ This only gets called if autoSignIn is true

#### Defined in

[src/AuthContextInterface.ts:131](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L131)
[src/AuthContextInterface.ts:136](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L136)

___

Expand All @@ -216,7 +229,7 @@ On sign out hook. Can be a async function.

#### Defined in

[src/AuthContextInterface.ts:136](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L136)
[src/AuthContextInterface.ts:141](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L141)

___

Expand All @@ -242,7 +255,7 @@ On sign out hook. Can be a async function.

#### Defined in

[src/AuthContextInterface.ts:140](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L140)
[src/AuthContextInterface.ts:145](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L145)

___

Expand All @@ -254,7 +267,7 @@ The URL for the page containing the call to signinPopupCallback to handle the ca

#### Defined in

[src/AuthContextInterface.ts:121](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L121)
[src/AuthContextInterface.ts:126](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L126)

___

Expand All @@ -268,7 +281,7 @@ defaults to 'location=no,toolbar=no,width=500,height=500,left=100,top=100'

#### Defined in

[src/AuthContextInterface.ts:116](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L116)
[src/AuthContextInterface.ts:121](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L121)

___

Expand All @@ -281,7 +294,7 @@ defaults to '_blank'

#### Defined in

[src/AuthContextInterface.ts:126](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L126)
[src/AuthContextInterface.ts:131](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L131)

___

Expand All @@ -293,7 +306,7 @@ The post-logout redirect URI of your client application which your OIDC/OAuth2 p

#### Defined in

[src/AuthContextInterface.ts:64](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L64)
[src/AuthContextInterface.ts:69](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L69)

___

Expand All @@ -305,7 +318,7 @@ The redirect URI of your client application to receive a response from the OIDC/

#### Defined in

[src/AuthContextInterface.ts:56](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L56)
[src/AuthContextInterface.ts:61](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L61)

___

Expand All @@ -319,7 +332,7 @@ Read more: https://tools.ietf.org/html/rfc6749#section-3.1.1

#### Defined in

[src/AuthContextInterface.ts:70](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L70)
[src/AuthContextInterface.ts:75](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L75)

___

Expand All @@ -331,7 +344,7 @@ A space-delimited list of permissions that the application requires.

#### Defined in

[src/AuthContextInterface.ts:74](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L74)
[src/AuthContextInterface.ts:79](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L79)

___

Expand All @@ -343,7 +356,7 @@ The redirect URI of your client application to receive a response from the OIDC/

#### Defined in

[src/AuthContextInterface.ts:60](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L60)
[src/AuthContextInterface.ts:65](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L65)

___

Expand All @@ -355,4 +368,4 @@ See [UserManager](https://github.com/authts/oidc-client-ts) for more details.

#### Defined in

[src/AuthContextInterface.ts:36](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L36)
[src/AuthContextInterface.ts:37](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L37)
2 changes: 1 addition & 1 deletion docs/interfaces/AuthProviderSignOutProps.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ const config = {

#### Defined in

[src/AuthContextInterface.ts:29](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L29)
[src/AuthContextInterface.ts:30](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L30)
4 changes: 2 additions & 2 deletions docs/interfaces/Location.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

#### Defined in

[src/AuthContextInterface.ts:10](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L10)
[src/AuthContextInterface.ts:11](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L11)

___

Expand All @@ -27,4 +27,4 @@ ___

#### Defined in

[src/AuthContextInterface.ts:9](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L9)
[src/AuthContextInterface.ts:10](https://github.com/bjerkio/oidc-react/blob/main/src/AuthContextInterface.ts#L10)
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@
"react-dom": "18.2.0",
"ts-jest": "29.1.0",
"ts-node-dev": "2.0.0",
"typedoc": "0.24.1",
"typedoc-plugin-markdown": "3.14.0",
"typedoc": "0.24.4",
"typedoc-plugin-markdown": "3.15.2",
"typescript": "5.0.4"
},
"peerDependencies": {
Expand Down
42 changes: 24 additions & 18 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -3849,10 +3849,10 @@ [email protected]:
dependencies:
tmpl "1.0.5"

marked@^4.2.12:
version "4.2.12"
resolved "https://registry.yarnpkg.com/marked/-/marked-4.2.12.tgz#d69a64e21d71b06250da995dcd065c11083bebb5"
integrity sha512-yr8hSKa3Fv4D3jdZmtMMPghgVt6TWbk86WQaWhDloQjRSQhMMYCAro7jP7VDJrjjdV8pxVxMssXS8B8Y5DZ5aw==
marked@^4.3.0:
version "4.3.0"
resolved "https://registry.yarnpkg.com/marked/-/marked-4.3.0.tgz#796362821b019f734054582038b116481b456cf3"
integrity sha512-PRsaiG84bK+AMvxziE/lCFss8juXjNaWzVbN5tXAm4XjeaS9NAHhop+PjQxz2A9h8Q4M/xGmzP8vqNwy6JeK0A==

merge-stream@^2.0.0:
version "2.0.0"
Expand Down Expand Up @@ -3901,10 +3901,10 @@ minimatch@^3.0.4, minimatch@^3.0.5, minimatch@^3.1.2:
dependencies:
brace-expansion "^1.1.7"

minimatch@^7.1.3:
version "7.4.2"
resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-7.4.2.tgz#157e847d79ca671054253b840656720cb733f10f"
integrity sha512-xy4q7wou3vUoC9k1xGTXc+awNdGaGVHtFUaey8tiX4H1QRc04DZ/rmDFwNm2EBsuYEhAZ6SgMmYf3InGY6OauA==
minimatch@^9.0.0:
version "9.0.0"
resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.0.tgz#bfc8e88a1c40ffd40c172ddac3decb8451503b56"
integrity sha512-0jJj8AvgKqWN05mrwuqi8QYKx1WmYSUoKSxu5Qhs9prezTz10sxAHGNZe9J9cqIJzta8DWsleh2KaVaLl6Ru2w==
dependencies:
brace-expansion "^2.0.1"

Expand Down Expand Up @@ -4977,21 +4977,27 @@ typed-array-length@^1.0.4:
for-each "^0.3.3"
is-typed-array "^1.1.9"

typedoc-plugin-markdown@3.14.0:
version "3.14.0"
resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.14.0.tgz#17b99ee3ab0d21046d253f185f7669e80d0d7891"
integrity sha512-UyQLkLRkfTFhLdhSf3RRpA3nNInGn+k6sll2vRXjflaMNwQAAiB61SYbisNZTg16t4K1dt1bPQMMGLrxS0GZ0Q==
typedoc-plugin-markdown@3.15.2:
version "3.15.2"
resolved "https://registry.yarnpkg.com/typedoc-plugin-markdown/-/typedoc-plugin-markdown-3.15.2.tgz#6d1c04e048cdf9fbc17652f8e9d674f51888a062"
integrity sha512-OPXAL9hhdoVJzH/UaKAz6CBS/s8KlYyLWwnxF7ap0fQCuaMMWShA1JBq4n1SXbiGjx+7DOhOfTKQ5OzwryN3Vw==
dependencies:
handlebars "^4.7.7"
typedoc-plugin-mdn-links "^3.0.3"

typedoc-plugin-mdn-links@^3.0.3:
version "3.0.3"
resolved "https://registry.yarnpkg.com/typedoc-plugin-mdn-links/-/typedoc-plugin-mdn-links-3.0.3.tgz#da8d1a9750d57333e6c21717b38bfc13d4058de2"
integrity sha512-NXhIpwQnsg7BcyMCHVqj3tUK+DL4g3Bt96JbFl4APzTGFkA+iM6GfZ/fn3TAqJ8O0CXG5R9BfWxolw1m1omNuQ==

[email protected].1:
version "0.24.1"
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.24.1.tgz#6b793a800400d46ec1b93246d175608626275c0b"
integrity sha512-u4HwjZcSQhQSkkhLjgcs0ooAf6HrFVLDHHrwU2xZW8WxH0KnGZlNkaWxiOcK5Gagj7mxJSgwWx0dv8ACDAOXAQ==
[email protected].4:
version "0.24.4"
resolved "https://registry.yarnpkg.com/typedoc/-/typedoc-0.24.4.tgz#bae677982115f94b9c6bc5d2bfa133350de7fedd"
integrity sha512-vQuliyGhJEGeKzzCFHbkS3m0gHoIL6cfr0fHf6eX658iGELtq2J9mWe0b+X5McEYgFoMuHFt5Py3Zug6Sxjn/Q==
dependencies:
lunr "^2.3.9"
marked "^4.2.12"
minimatch "^7.1.3"
marked "^4.3.0"
minimatch "^9.0.0"
shiki "^0.14.1"

[email protected]:
Expand Down

0 comments on commit 5e5ef61

Please sign in to comment.