Skip to content

Commit 4e0cb3d

Browse files
committed
Merge branch 'main' into initial-usage-docs
2 parents be01551 + 6dd8b13 commit 4e0cb3d

4 files changed

Lines changed: 13 additions & 3 deletions

File tree

src/AuthorizationCodeFlow.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,6 @@ const html = `
6262
*
6363
* @example Minimal usage
6464
* ```html
65-
* <script src="https://unpkg.com/@solid/reactive-authentication/dist/registerElements.js"></script>
6665
* <authorization-code-flow></authorization-code-flow>
6766
* ```
6867
*
@@ -141,7 +140,7 @@ export class AuthorizationCodeFlow extends HTMLElement {
141140
}
142141

143142
/**
144-
* a {@link GetCodeCallback} that provides an authorization code by directing the user to the {@link authorizationUri authorization endpoint URI} in a popup and waiting for the code in a redirect back.
143+
* a {@link GetCodeCallback} that provides an authorization code by directing the user to the authorization endpoint URI in a popup and waiting for the code in a redirect back.
145144
*
146145
* @remarks Only one flow runs at a time. Any number of calls
147146
*

src/IdpPicker.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,21 @@ const html = `
3838
</dialog>
3939
`
4040

41+
/**
42+
* A web component (custom HTML element) that prompts the user for the URI of the authorization server (identity provider) to use for a request.
43+
*
44+
* @remarks
45+
* This element is not {@link customElements.define defined} when importing the module. Import {@link registerElements} to define it.
46+
*
47+
* See the {@link getIssuer} method for integrating this element into your application.
48+
*/
4149
export class IdpPicker extends HTMLElement {
4250
readonly #mutex = new Mutex
4351
#dialog!: HTMLDialogElement
4452
#input!: HTMLInputElement
4553
#code!: HTMLElement
4654

55+
/** @ignore */
4756
connectedCallback() {
4857
const template = this.ownerDocument.createElement("template")
4958
template.innerHTML = html

src/mod.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ export * from "./ReactiveAuthenticationError.js"
88
export * from "./ClientCredentialsTokenProvider.js"
99
export * from "./GetCodeCallback.js"
1010
export * from "./issuerFrom.js"
11+
export * from "./TokenProvider.js"
1112
export * from "./GetIssuerCallback.js"
1213
export * from "./IdpPicker.js"
1314
export * from "./IssuerRequestCancelledError.js"

typedoc.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
"ts",
55
"javascript",
66
"html",
7-
"css"
7+
"css",
8+
"batch"
89
],
910
"plugin": [
1011
"typedoc-plugin-mdn-links"

0 commit comments

Comments
 (0)