Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,16 +74,42 @@ methods:
return:
description: ''
type: <xref uid="@azure/msal-common.Logger" />
- name: handleRedirectObservable()
uid: '@azure/msal-angular.IMsalService.handleRedirectObservable'
- name: handleRedirectObservable(HandleRedirectPromiseOptions)
uid: '@azure/msal-angular.IMsalService.handleRedirectObservable_1'
package: '@azure/msal-angular'
summary: ''
remarks: ''
isDeprecated: false
syntax:
content: >-
function handleRedirectObservable(): Observable<null |
function handleRedirectObservable(options?:
HandleRedirectPromiseOptions): Observable<null | AuthenticationResult>
parameters:
- id: options
type: <xref uid="@azure/msal-browser.HandleRedirectPromiseOptions" />
description: ''
return:
description: ''
type: >-
Observable&lt;null | <xref
uid="@azure/msal-browser.AuthenticationResult" />&gt;
- name: handleRedirectObservable(string)
uid: '@azure/msal-angular.IMsalService.handleRedirectObservable'
package: '@azure/msal-angular'
summary: ''
remarks: ''
isDeprecated: true
customDeprecatedMessage: >-
Pass options object instead of hash string. Use handleRedirectObservable({
hash: "#..." }) instead.
syntax:
content: >-
function handleRedirectObservable(hash: string): Observable<null |
AuthenticationResult>
parameters:
- id: hash
type: string
description: ''
return:
description: ''
type: >-
Expand Down
41 changes: 36 additions & 5 deletions msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,25 +140,56 @@ methods:
return:
description: ''
type: <xref uid="@azure/msal-common.Logger" />
- name: handleRedirectObservable(HandleRedirectPromiseOptions)
uid: '@azure/msal-angular.MsalService.handleRedirectObservable_1'
package: '@azure/msal-angular'
summary: >-
Handles the redirect response from authentication. Call this on every page
load after a redirect-based login.

If no options are provided, the service will attempt to use the cached
redirect hash captured during construction.
remarks: ''
isDeprecated: false
syntax:
content: >-
function handleRedirectObservable(options?:
HandleRedirectPromiseOptions): Observable<null | AuthenticationResult>
parameters:
- id: options
type: <xref uid="@azure/msal-browser.HandleRedirectPromiseOptions" />
description: >-
Optional configuration for redirect handling, such as an explicit
hash value to process.
return:
description: >-
Observable that emits the AuthenticationResult when a redirect is
successfully handled.
type: >-
Observable&lt;null | <xref
uid="@azure/msal-browser.AuthenticationResult" />&gt;
- name: handleRedirectObservable(string)
uid: '@azure/msal-angular.MsalService.handleRedirectObservable'
package: '@azure/msal-angular'
summary: ''
remarks: ''
isDeprecated: false
isDeprecated: true
customDeprecatedMessage: >-
Pass options object instead of hash string. Use handleRedirectObservable({
hash: "#..." }) instead.
syntax:
content: >-
function handleRedirectObservable(hash?: string):
Observable<AuthenticationResult>
function handleRedirectObservable(hash: string): Observable<null |
AuthenticationResult>
parameters:
- id: hash
type: string
description: ''
return:
description: ''
type: >-
Observable&lt;<xref uid="@azure/msal-browser.AuthenticationResult"
/>&gt;
Observable&lt;null | <xref
uid="@azure/msal-browser.AuthenticationResult" />&gt;
- name: initialize()
uid: '@azure/msal-angular.MsalService.initialize'
package: '@azure/msal-angular'
Expand Down
4 changes: 2 additions & 2 deletions msal/docs-ref-autogen/@azure/msal-angular/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ variables:
remarks: ''
isDeprecated: false
syntax:
content: 'version: "5.0.3"'
content: 'version: "5.0.4"'
return:
description: ''
type: '"<xref uid="5.0.3" />"'
type: '"<xref uid="5.0.4" />"'
10 changes: 7 additions & 3 deletions msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,20 +48,24 @@ methods:
return:
description: ''
type: null | string
- name: emitEvent(EventType, InteractionType, EventPayload, EventError)
- name: emitEvent(EventType, string, InteractionType, EventPayload, EventError)
uid: '@azure/msal-browser.EventHandler.emitEvent'
package: '@azure/msal-browser'
summary: Emits events by calling callback with event message
remarks: ''
isDeprecated: false
syntax:
content: >-
function emitEvent(eventType: EventType, interactionType?:
InteractionType, payload?: EventPayload, error?: EventError)
function emitEvent(eventType: EventType, correlationId: string,
interactionType?: InteractionType, payload?: EventPayload, error?:
EventError)
parameters:
- id: eventType
type: <xref uid="@azure/msal-browser.EventType" />
description: ''
- id: correlationId
type: string
description: ''
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The newly added correlationId parameter is undocumented (empty description). Add a short description explaining what the ID represents (e.g., request/operation correlation used for telemetry/tracing) and any expectations about its format.

Suggested change
description: ''
description: Identifier used to correlate related events and operations for telemetry and tracing (typically a unique string such as a GUID).

Copilot uses AI. Check for mistakes.
- id: interactionType
type: <xref uid="@azure/msal-browser.InteractionType" />
description: ''
Expand Down
1 change: 1 addition & 0 deletions msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ remarks: ''
isDeprecated: false
syntax: |
type EventMessage = {
correlationId: string
error: EventError
eventType: EventType
interactionType: InteractionType | null
Expand Down
4 changes: 2 additions & 2 deletions msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ methods:
description: ''
- id: options
type: <xref uid="@azure/msal-browser.NetworkRequestOptions" />
description: ''
description: Headers and/or body to include on the request
- id: timeout
type: number
description: ''
Expand All @@ -53,7 +53,7 @@ methods:
description: ''
- id: options
type: <xref uid="@azure/msal-browser.NetworkRequestOptions" />
description: ''
description: Headers and/or body to include on the request
return:
description: ''
type: >-
Expand Down
4 changes: 2 additions & 2 deletions msal/docs-ref-autogen/@azure/msal-browser/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -446,10 +446,10 @@ variables:
remarks: ''
isDeprecated: false
syntax:
content: 'version: "5.1.0"'
content: 'version: "5.2.0"'
return:
description: ''
type: '"<xref uid="5.1.0" />"'
type: '"<xref uid="5.2.0" />"'
functions:
- name: >-
createNestablePublicClientApplication(Configuration, string,
Expand Down
4 changes: 2 additions & 2 deletions msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ methods:
description: ''
- id: options
type: <xref uid="@azure/msal-common.NetworkRequestOptions" />
description: ''
description: Headers and/or body to include on the request
- id: timeout
type: number
description: ''
Expand All @@ -53,7 +53,7 @@ methods:
description: ''
- id: options
type: <xref uid="@azure/msal-common.NetworkRequestOptions" />
description: ''
description: Headers and/or body to include on the request
return:
description: ''
type: >-
Expand Down
4 changes: 2 additions & 2 deletions msal/docs-ref-autogen/@azure/msal-common/index.yml
Original file line number Diff line number Diff line change
Expand Up @@ -221,10 +221,10 @@ variables:
remarks: ''
isDeprecated: false
syntax:
content: 'version: "16.0.3"'
content: 'version: "16.0.4"'
return:
description: ''
type: '"<xref uid="16.0.3" />"'
type: '"<xref uid="16.0.4" />"'
functions:
- name: >-
buildAccountToCache(CacheManager, Authority, string, (input: string) =>
Expand Down
2 changes: 1 addition & 1 deletion msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ methods:
jwtAudience: string): string
parameters:
- id: cryptoProvider
type: CryptoProvider
type: <xref uid="@azure/msal-node.CryptoProvider" />
description: library's crypto helper
- id: issuer
type: string
Expand Down
152 changes: 152 additions & 0 deletions msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
### YamlMime:TSType
name: CryptoProvider
uid: '@azure/msal-node.CryptoProvider'
package: '@azure/msal-node'
summary: >-
This class implements MSAL node's crypto interface, which allows it to perform
base64 encoding and decoding, generating cryptographically random GUIDs and

implementing Proof Key for Code Exchange specs for the OAuth Authorization
Code Flow using PKCE (rfc here: https://tools.ietf.org/html/rfc7636).
fullName: CryptoProvider
remarks: ''
isDeprecated: false
type: class
methods:
- name: base64Decode(string)
uid: '@azure/msal-node.CryptoProvider.base64Decode'
package: '@azure/msal-node'
summary: Decodes input string from base64.
remarks: ''
isDeprecated: false
syntax:
content: 'function base64Decode(input: string): string'
parameters:
- id: input
type: string
description: string to be decoded
return:
description: ''
type: string
- name: base64Encode(string)
uid: '@azure/msal-node.CryptoProvider.base64Encode'
package: '@azure/msal-node'
summary: Encodes input string to base64.
remarks: ''
isDeprecated: false
syntax:
content: 'function base64Encode(input: string): string'
parameters:
- id: input
type: string
description: string to be encoded
return:
description: ''
type: string
- name: base64UrlEncode()
uid: '@azure/msal-node.CryptoProvider.base64UrlEncode'
package: '@azure/msal-node'
summary: base64 URL safe encoded string
remarks: ''
isDeprecated: false
syntax:
content: 'function base64UrlEncode(): string'
return:
description: ''
type: string
Comment on lines +46 to +56
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The base64UrlEncode summary implies an encoded output but the signature has no input parameter, which makes the generated API doc ambiguous. Either add the missing input parameter to the underlying type declarations/DocFX generation, or adjust the summary to clarify what is being encoded (e.g., internal state vs. provided input).

Copilot uses AI. Check for mistakes.
- name: clearKeystore()
uid: '@azure/msal-node.CryptoProvider.clearKeystore'
package: '@azure/msal-node'
summary: Removes all cryptographic keys from Keystore
remarks: ''
isDeprecated: false
syntax:
content: 'function clearKeystore(): Promise<boolean>'
return:
description: ''
type: Promise&lt;boolean&gt;
- name: createNewGuid()
uid: '@azure/msal-node.CryptoProvider.createNewGuid'
package: '@azure/msal-node'
summary: Creates a new random GUID - used to populate state and nonce.
remarks: ''
isDeprecated: false
syntax:
content: 'function createNewGuid(): string'
return:
description: string (GUID)
type: string
- name: encodeKid()
uid: '@azure/msal-node.CryptoProvider.encodeKid'
package: '@azure/msal-node'
summary: Stringifies and base64Url encodes input public key
remarks: ''
isDeprecated: false
syntax:
content: 'function encodeKid(): string'
return:
description: Base64Url encoded public key
type: string
Comment on lines +79 to +89
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The encodeKid summary says it encodes an input public key, but the signature does not accept any parameters. Update generation/source typings so the input is documented as a parameter, or reword the summary/return description to match a parameterless method.

Copilot uses AI. Check for mistakes.
- name: generatePkceCodes()
uid: '@azure/msal-node.CryptoProvider.generatePkceCodes'
package: '@azure/msal-node'
summary: Generates PKCE codes used in Authorization Code Flow.
remarks: ''
isDeprecated: false
syntax:
content: 'function generatePkceCodes(): Promise<PkceCodes>'
return:
description: ''
type: Promise&lt;<xref uid="@azure/msal-common.PkceCodes" />&gt;
- name: getPublicKeyThumbprint()
uid: '@azure/msal-node.CryptoProvider.getPublicKeyThumbprint'
package: '@azure/msal-node'
summary: >-
Generates a keypair, stores it and returns a thumbprint - not yet
implemented for node
remarks: ''
isDeprecated: false
syntax:
content: 'function getPublicKeyThumbprint(): Promise<string>'
return:
description: ''
type: Promise&lt;string&gt;
- name: hashString(string)
uid: '@azure/msal-node.CryptoProvider.hashString'
package: '@azure/msal-node'
summary: Returns the SHA-256 hash of an input string
remarks: ''
isDeprecated: false
syntax:
content: 'function hashString(plainText: string): Promise<string>'
parameters:
- id: plainText
type: string
description: ''
return:
description: ''
type: Promise&lt;string&gt;
- name: removeTokenBindingKey()
uid: '@azure/msal-node.CryptoProvider.removeTokenBindingKey'
package: '@azure/msal-node'
summary: Removes cryptographic keypair from key store matching the keyId passed in
remarks: ''
isDeprecated: false
syntax:
content: 'function removeTokenBindingKey(): Promise<void>'
return:
description: ''
type: Promise&lt;void&gt;
Comment on lines +129 to +139
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The summary references a keyId being passed in, but the method signature has no parameters. Align the docs with the actual API by documenting the keyId parameter (if the API requires it) or rewriting the summary to reflect the parameterless behavior.

Copilot uses AI. Check for mistakes.
- name: signJwt()
uid: '@azure/msal-node.CryptoProvider.signJwt'
package: '@azure/msal-node'
summary: >-
Signs the given object as a jwt payload with private key retrieved by
given kid - currently not implemented for node
remarks: ''
isDeprecated: false
syntax:
content: 'function signJwt(): Promise<string>'
return:
description: ''
type: Promise&lt;string&gt;
Comment on lines +140 to +152
Copy link

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The signJwt summary mentions signing a given object and using a provided kid, but the signature shows no parameters. Please update the generated docs (or underlying type declarations) to include the payload and kid parameters, or change the summary to match a parameterless method.

Copilot uses AI. Check for mistakes.
4 changes: 2 additions & 2 deletions msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ methods:
description: ''
- id: options
type: <xref uid="@azure/msal-node.NetworkRequestOptions" />
description: ''
description: Headers and/or body to include on the request
- id: timeout
type: number
description: ''
Expand All @@ -53,7 +53,7 @@ methods:
description: ''
- id: options
type: <xref uid="@azure/msal-node.NetworkRequestOptions" />
description: ''
description: Headers and/or body to include on the request
return:
description: ''
type: >-
Expand Down
Loading