Conversation
Build.Reason:Schedule Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=590213&view=results
|
Learn Build status updates of commit 0a5f881:
|
PoliCheck Scan ReportThe following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans. ✅ No issues foundMore information about PoliCheckInformation: PoliCheck | Severity Guidance | Term |
There was a problem hiding this comment.
Pull request overview
Updates the generated MSAL reference docs to reflect new package versions and newly exposed/updated API surface.
Changes:
- Bumps documented package versions across msal-common/browser/angular/react/node.
- Adds
CryptoProviderto msal-node reference output (index + TOC + type page) and updates references to it. - Updates network-module parameter descriptions and extends browser event APIs with
correlationIdin the docs.
Reviewed changes
Copilot reviewed 15 out of 15 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| msal/docs-ref-autogen/toc.yml | Adds CryptoProvider entry to the generated TOC. |
| msal/docs-ref-autogen/@azure/msal-react/index.yml | Updates documented msal-react version to 5.0.4. |
| msal/docs-ref-autogen/@azure/msal-node/index.yml | Adds CryptoProvider to class list and bumps version to 5.0.4. |
| msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml | Improves options parameter description. |
| msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml | Introduces generated reference page for CryptoProvider. |
| msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml | Updates cryptoProvider param to link to CryptoProvider xref. |
| msal/docs-ref-autogen/@azure/msal-common/index.yml | Updates documented msal-common version to 16.0.4. |
| msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml | Improves options parameter description. |
| msal/docs-ref-autogen/@azure/msal-browser/index.yml | Updates documented msal-browser version to 5.2.0. |
| msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml | Improves options parameter description. |
| msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml | Adds correlationId to the documented event message shape. |
| msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml | Documents emitEvent as taking correlationId. |
| msal/docs-ref-autogen/@azure/msal-angular/index.yml | Updates documented msal-angular version to 5.0.4. |
| msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml | Documents new handleRedirectObservable(options) overload and deprecates handleRedirectObservable(hash). |
| msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml | Mirrors the handleRedirectObservable overload/deprecation in the interface docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - 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 |
There was a problem hiding this comment.
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).
| - 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 |
There was a problem hiding this comment.
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.
| - 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<void> |
There was a problem hiding this comment.
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.
| - 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<string> |
There was a problem hiding this comment.
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.
| description: '' | ||
| - id: correlationId | ||
| type: string | ||
| description: '' |
There was a problem hiding this comment.
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.
| description: '' | |
| description: Identifier used to correlate related events and operations for telemetry and tracing (typically a unique string such as a GUID). |
Build.Reason:Schedule
Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=590213&view=results