diff --git a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml index f1d27ba..8dba702 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/IMsalService.yml @@ -74,16 +74,42 @@ methods: return: description: '' type: - - 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 + parameters: + - id: options + type: + description: '' + return: + description: '' + type: >- + Observable<null | > + - 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 + parameters: + - id: hash + type: string + description: '' return: description: '' type: >- diff --git a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml index 7b61f51..a3e97f7 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/MsalService.yml @@ -140,16 +140,47 @@ methods: return: description: '' type: + - 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 + parameters: + - id: options + type: + 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<null | > - 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 + function handleRedirectObservable(hash: string): Observable parameters: - id: hash type: string @@ -157,8 +188,8 @@ methods: return: description: '' type: >- - Observable<> + Observable<null | > - name: initialize() uid: '@azure/msal-angular.MsalService.initialize' package: '@azure/msal-angular' diff --git a/msal/docs-ref-autogen/@azure/msal-angular/index.yml b/msal/docs-ref-autogen/@azure/msal-angular/index.yml index 71c34a8..dc3787c 100644 --- a/msal/docs-ref-autogen/@azure/msal-angular/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-angular/index.yml @@ -80,7 +80,7 @@ variables: remarks: '' isDeprecated: false syntax: - content: 'version: "5.0.3"' + content: 'version: "5.0.4"' return: description: '' - type: '""' + type: '""' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml index 5ed32e6..421fb5d 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventHandler.yml @@ -48,7 +48,7 @@ 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 @@ -56,12 +56,16 @@ methods: 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: description: '' + - id: correlationId + type: string + description: '' - id: interactionType type: description: '' diff --git a/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml b/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml index 4d17ab8..b402426 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/EventMessage.yml @@ -8,6 +8,7 @@ remarks: '' isDeprecated: false syntax: | type EventMessage = { + correlationId: string error: EventError eventType: EventType interactionType: InteractionType | null diff --git a/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml index 4d024b8..63d39e1 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/INetworkModule.yml @@ -26,7 +26,7 @@ methods: description: '' - id: options type: - description: '' + description: Headers and/or body to include on the request - id: timeout type: number description: '' @@ -53,7 +53,7 @@ methods: description: '' - id: options type: - description: '' + description: Headers and/or body to include on the request return: description: '' type: >- diff --git a/msal/docs-ref-autogen/@azure/msal-browser/index.yml b/msal/docs-ref-autogen/@azure/msal-browser/index.yml index 888b68f..a734d78 100644 --- a/msal/docs-ref-autogen/@azure/msal-browser/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-browser/index.yml @@ -446,10 +446,10 @@ variables: remarks: '' isDeprecated: false syntax: - content: 'version: "5.1.0"' + content: 'version: "5.2.0"' return: description: '' - type: '""' + type: '""' functions: - name: >- createNestablePublicClientApplication(Configuration, string, diff --git a/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml index 218987f..3a052dd 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/INetworkModule.yml @@ -26,7 +26,7 @@ methods: description: '' - id: options type: - description: '' + description: Headers and/or body to include on the request - id: timeout type: number description: '' @@ -53,7 +53,7 @@ methods: description: '' - id: options type: - description: '' + description: Headers and/or body to include on the request return: description: '' type: >- diff --git a/msal/docs-ref-autogen/@azure/msal-common/index.yml b/msal/docs-ref-autogen/@azure/msal-common/index.yml index 744f09c..497b15a 100644 --- a/msal/docs-ref-autogen/@azure/msal-common/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-common/index.yml @@ -221,10 +221,10 @@ variables: remarks: '' isDeprecated: false syntax: - content: 'version: "16.0.3"' + content: 'version: "16.0.4"' return: description: '' - type: '""' + type: '""' functions: - name: >- buildAccountToCache(CacheManager, Authority, string, (input: string) => diff --git a/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml b/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml index 754b3ca..cd8f368 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/ClientAssertion.yml @@ -96,7 +96,7 @@ methods: jwtAudience: string): string parameters: - id: cryptoProvider - type: CryptoProvider + type: description: library's crypto helper - id: issuer type: string diff --git a/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml b/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml new file mode 100644 index 0000000..0170ab2 --- /dev/null +++ b/msal/docs-ref-autogen/@azure/msal-node/CryptoProvider.yml @@ -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 + - 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' + return: + description: '' + type: Promise<boolean> + - 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 + - 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' + return: + description: '' + type: Promise<> + - 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' + return: + description: '' + type: Promise<string> + - 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' + parameters: + - id: plainText + type: string + description: '' + return: + description: '' + type: Promise<string> + - 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' + return: + description: '' + type: Promise<void> + - 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' + return: + description: '' + type: Promise<string> diff --git a/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml b/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml index 5288d8d..c97c7b9 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/INetworkModule.yml @@ -26,7 +26,7 @@ methods: description: '' - id: options type: - description: '' + description: Headers and/or body to include on the request - id: timeout type: number description: '' @@ -53,7 +53,7 @@ methods: description: '' - id: options type: - description: '' + description: Headers and/or body to include on the request return: description: '' type: >- diff --git a/msal/docs-ref-autogen/@azure/msal-node/index.yml b/msal/docs-ref-autogen/@azure/msal-node/index.yml index 02645cb..d9e1727 100644 --- a/msal/docs-ref-autogen/@azure/msal-node/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-node/index.yml @@ -11,6 +11,7 @@ classes: - '@azure/msal-node.ClientAuthError' - '@azure/msal-node.ClientConfigurationError' - '@azure/msal-node.ConfidentialClientApplication' + - '@azure/msal-node.CryptoProvider' - '@azure/msal-node.DistributedCachePlugin' - '@azure/msal-node.InteractionRequiredAuthError' - '@azure/msal-node.Logger' @@ -156,7 +157,7 @@ variables: remarks: '' isDeprecated: false syntax: - content: 'version: "5.0.3"' + content: 'version: "5.0.4"' return: description: '' - type: '""' + type: '""' diff --git a/msal/docs-ref-autogen/@azure/msal-react/index.yml b/msal/docs-ref-autogen/@azure/msal-react/index.yml index 2341e6b..be7bafc 100644 --- a/msal/docs-ref-autogen/@azure/msal-react/index.yml +++ b/msal/docs-ref-autogen/@azure/msal-react/index.yml @@ -50,10 +50,10 @@ variables: remarks: '' isDeprecated: false syntax: - content: 'version: "5.0.3"' + content: 'version: "5.0.4"' return: description: '' - type: '""' + type: '""' functions: - name: >- AuthenticatedTemplate(PropsWithChildren