@azure/msal-node
Advanced tools
Comparing version 2.0.0 to 2.0.1
@@ -40,4 +40,4 @@ /** | ||
export type { InteractiveRequest } from "./request/InteractiveRequest"; | ||
export { PromptValue, ResponseMode, AuthorizationCodePayload, AuthenticationResult, ServerAuthorizationCodeResponse, IdTokenClaims, AccountInfo, ValidCacheType, AuthError, AuthErrorMessage, ClientAuthError, ClientAuthErrorMessage, ClientConfigurationError, ClientConfigurationErrorMessage, InteractionRequiredAuthError, InteractionRequiredAuthErrorMessage, ServerError, INetworkModule, NetworkRequestOptions, NetworkResponse, Logger, LogLevel, ProtocolMode, ICachePlugin, TokenCacheContext, ISerializableTokenCache, AzureCloudInstance, AzureCloudOptions, IAppTokenProvider, AppTokenProviderParameters, AppTokenProviderResult } from "@azure/msal-common"; | ||
export { PromptValue, ResponseMode, AuthorizationCodePayload, AuthenticationResult, ServerAuthorizationCodeResponse, IdTokenClaims, AccountInfo, ValidCacheType, AuthError, AuthErrorMessage, ClientAuthError, ClientAuthErrorMessage, ClientConfigurationError, ClientConfigurationErrorMessage, InteractionRequiredAuthError, InteractionRequiredAuthErrorMessage, ServerError, INetworkModule, NetworkRequestOptions, NetworkResponse, Logger, LogLevel, ProtocolMode, ICachePlugin, TokenCacheContext, ISerializableTokenCache, AzureCloudInstance, AzureCloudOptions, IAppTokenProvider, AppTokenProviderParameters, AppTokenProviderResult, } from "@azure/msal-common"; | ||
export { version } from "./packageMetadata"; | ||
//# sourceMappingURL=index.d.ts.map |
export declare const name = "@azure/msal-node"; | ||
export declare const version = "2.0.0"; | ||
export declare const version = "2.0.1"; | ||
//# sourceMappingURL=packageMetadata.d.ts.map |
{ | ||
"name": "@azure/msal-node", | ||
"version": "2.0.0", | ||
"version": "2.0.1", | ||
"author": { | ||
@@ -24,3 +24,3 @@ "name": "Microsoft", | ||
"type": "module", | ||
"module": "dist/index.esm.js", | ||
"module": "dist/index.mjs", | ||
"types": "dist/index.d.ts", | ||
@@ -30,6 +30,6 @@ "exports": { | ||
"types": "./dist/index.d.ts", | ||
"module": "./dist/index.esm.js", | ||
"import": "./dist/index.esm.js", | ||
"require": "./dist/index.js", | ||
"default": "./dist/index.esm.js" | ||
"module": "./dist/index.mjs", | ||
"import": "./dist/index.mjs", | ||
"require": "./dist/index.cjs", | ||
"default": "./dist/index.mjs" | ||
}, | ||
@@ -42,4 +42,5 @@ "./package.json": "./package.json" | ||
"scripts": { | ||
"build": "rollup -c --strictDeprecations --bundleConfigAsCjs", | ||
"build": "npm run clean && rollup -c --strictDeprecations --bundleConfigAsCjs", | ||
"build:watch": "rollup -c --watch --strictDeprecations --bundleConfigAsCjs", | ||
"clean": "shx rm -rf dist lib", | ||
"test": "jest", | ||
@@ -56,3 +57,5 @@ "test:watch": "jest --watch", | ||
"beachball": { | ||
"disallowedChangeTypes": [] | ||
"disallowedChangeTypes": [ | ||
"major" | ||
] | ||
}, | ||
@@ -78,3 +81,3 @@ "devDependencies": { | ||
"dependencies": { | ||
"@azure/msal-common": "14.0.0", | ||
"@azure/msal-common": "14.0.1", | ||
"jsonwebtoken": "^9.0.0", | ||
@@ -86,2 +89,2 @@ "uuid": "^8.3.0" | ||
} | ||
} | ||
} |
103
README.md
@@ -8,3 +8,3 @@ # Microsoft Authentication Library for Node (msal-node) | ||
| <a href="https://docs.microsoft.com/azure/active-directory/develop/guidedsetups/active-directory-javascriptspa" target="_blank">Getting Started</a> | <a href="https://aka.ms/aaddevv2" target="_blank">AAD Docs</a> | <a href="https://azuread.github.io/microsoft-authentication-library-for-js/ref/modules/_azure_msal_node.html" target="_blank">Library Reference</a> | | ||
| --- | --- | --- | | ||
| --------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
@@ -33,18 +33,17 @@ 1. [About](#about) | ||
#### Public Client: | ||
- [Authorization Code Grant](https://oauth.net/2/grant-types/authorization-code/) with [PKCE](https://oauth.net/2/pkce/) | ||
- [Device Code Grant](https://oauth.net/2/grant-types/device-code/) | ||
- [Refresh Token Grant](https://oauth.net/2/grant-types/refresh-token/) | ||
- [Silent Flow](https://docs.microsoft.com/azure/active-directory/develop/msal-acquire-cache-tokens#acquiring-tokens-silently-from-the-cache) | ||
- [Username and Password flow](https://docs.microsoft.com/azure/active-directory/develop/msal-authentication-flows#usernamepassword) | ||
- [Authorization Code Grant](https://oauth.net/2/grant-types/authorization-code/) with [PKCE](https://oauth.net/2/pkce/) | ||
- [Device Code Grant](https://oauth.net/2/grant-types/device-code/) | ||
- [Refresh Token Grant](https://oauth.net/2/grant-types/refresh-token/) | ||
- [Silent Flow](https://docs.microsoft.com/azure/active-directory/develop/msal-acquire-cache-tokens#acquiring-tokens-silently-from-the-cache) | ||
- [Username and Password flow](https://docs.microsoft.com/azure/active-directory/develop/msal-authentication-flows#usernamepassword) | ||
#### Confidential Client: | ||
- [Authorization Code Grant](https://oauth.net/2/grant-types/authorization-code/) with a client credential | ||
- [Refresh Token Grant](https://oauth.net/2/grant-types/refresh-token/) | ||
- [Silent Flow](https://docs.microsoft.com/azure/active-directory/develop/msal-acquire-cache-tokens#acquiring-tokens-silently-from-the-cache) | ||
- [Client Credential Grant](https://oauth.net/2/grant-types/client-credentials/) | ||
- [On-behalf-of flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow) | ||
- [Username and Password flow](https://docs.microsoft.com/azure/active-directory/develop/msal-authentication-flows#usernamepassword) | ||
**[Coming Soon]** In the future we plan to add support for: | ||
- [Integrated Windows Authentication flow](https://docs.microsoft.com/azure/active-directory/develop/msal-authentication-flows#integrated-windows-authentication) | ||
- [Authorization Code Grant](https://oauth.net/2/grant-types/authorization-code/) with a client credential | ||
- [Refresh Token Grant](https://oauth.net/2/grant-types/refresh-token/) | ||
- [Silent Flow](https://docs.microsoft.com/azure/active-directory/develop/msal-acquire-cache-tokens#acquiring-tokens-silently-from-the-cache) | ||
- [Client Credential Grant](https://oauth.net/2/grant-types/client-credentials/) | ||
- [On-behalf-of flow](https://docs.microsoft.com/azure/active-directory/develop/v2-oauth2-on-behalf-of-flow) | ||
- [Username and Password flow](https://docs.microsoft.com/azure/active-directory/develop/msal-authentication-flows#usernamepassword) | ||
@@ -56,7 +55,8 @@ More details on different grant types supported by Microsoft authentication libraries in general can be found [here](https://docs.microsoft.com/azure/active-directory/develop/msal-authentication-flows). | ||
The scenarios supported with this library are: | ||
- Desktop app that calls web APIs | ||
- Web app that calls web APIs | ||
- Web APIs that call web APIs | ||
- Daemon apps | ||
- Desktop app that calls web APIs | ||
- Web app that calls web APIs | ||
- Web APIs that call web APIs | ||
- Daemon apps | ||
More details on scenarios and the authentication flows that map to each of them can be found [here](https://docs.microsoft.com/azure/active-directory/develop/authentication-flows-app-scenarios). | ||
@@ -72,3 +72,3 @@ | ||
- [App registration](https://docs.microsoft.com/graph/auth-register-app-v2) | ||
- [App registration](https://docs.microsoft.com/graph/auth-register-app-v2) | ||
@@ -78,30 +78,35 @@ ## Installation | ||
### Via NPM: | ||
```javascript | ||
npm install @azure/msal-node | ||
``` | ||
## Node Version Support | ||
MSAL Node will follow the [Long Term Support (LTS) schedule of the Node.js project](https://nodejs.org/about/releases/). Our support plan is as follows. | ||
Any major MSAL Node release: | ||
- Will support stable (even-numbered) Maintenance LTS, Active LTS, and Current versions of Node | ||
- Will drop support for any previously supported Node versions that have reached end of life | ||
- Will not support prerelease/preview/pending versions until they are stable | ||
| MSAL Node version | MSAL support status | Supported Node versions | | ||
|-------------------|-------------------------|-------------------------| | ||
| 1.x.x | Active development | 10, 12, 14, 16, 18 | | ||
| 2.x.x | Pre-release | 18, 20 | | ||
- Will support stable (even-numbered) Maintenance LTS, Active LTS, and Current versions of Node | ||
- Will drop support for any previously supported Node versions that have reached end of life | ||
- Will not support prerelease/preview/pending versions until they are stable | ||
| MSAL Node version | MSAL support status | Supported Node versions | | ||
| ----------------- | ------------------- | ----------------------- | | ||
| 1.x.x | Long-term Support | 10, 12, 14, 16, 18 | | ||
| 2.x.x | Active development | 18, 20 | | ||
## Usage | ||
## Usage | ||
### MSAL basics | ||
- [Understand difference in between Public Client and Confidential Clients](https://docs.microsoft.com/azure/active-directory/develop/msal-client-applications) | ||
- [Initialize a Public Client Application](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/initialize-public-client-application.md) | ||
- [Initialize a Confidential Client Application](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/initialize-confidential-client-application.md) | ||
- [Configuration](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/configuration.md) | ||
- [Request](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/request.md) | ||
- [Response](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/Response.md) | ||
- [Understand difference in between Public Client and Confidential Clients](https://docs.microsoft.com/azure/active-directory/develop/msal-client-applications) | ||
- [Initialize a Public Client Application](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/initialize-public-client-application.md) | ||
- [Initialize a Confidential Client Application](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/initialize-confidential-client-application.md) | ||
- [Configuration](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/configuration.md) | ||
- [Request](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/request.md) | ||
- [Response](https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-common/docs/Response.md) | ||
## Samples | ||
There are multiple [samples](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples) included in the repository that use MSAL Node to acquire tokens. These samples are currently used for manual testing, and are not meant to be a reference of best practices, therefore use judgement and do not blindly copy this code to any production applications. | ||
@@ -111,20 +116,20 @@ | ||
- [auth-code](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/auth-code): Express app using OAuth2.0 authorization code flow. | ||
- [auth-code-pkce](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/auth-code-pkce): Express app using OAuth2.0 authorization code flow with PKCE. | ||
- [device-code](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/device-code): Command line app using OAuth 2.0 device code flow. | ||
- [refresh-token](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/refresh-token): Command line app using OAuth 2.0 refresh flow. | ||
- [silent-flow](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/silent-flow): Express app using OAuth2.0 authorization code flow to acquire a token and store in the token cache, and silent flow to use tokens in the token cache. | ||
- [client-credentials](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/client-credentials): Daemon app using OAuth 2.0 client credential grant to acquire a token. | ||
- [on-behalf-of](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/on-behalf-of): Web application using OAuth 2.0 auth code flow to acquire a token for a web API. The web API validates the token, and calls Microsoft Graph on behalf of the user who authenticated in the web application. | ||
- [username-password](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/username-password): Web application using OAuth 2.0 resource owner password credentials (ROPC) flow to acquire a token for a web API. | ||
- [ElectronTestApp](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/ElectronTestApp): Electron desktop application using OAuth 2.0 auth code with PKCE flow to acquire a token for a web API such as Microsoft Graph. | ||
- [Hybrid Spa Sample](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-browser-samples/HybridSample): Sample demonstrating how to use `enableSpaAuthorizationCode` to perform SSO for applications that leverage server-side and client-side authentication using MSAL Browser and MSAL Node. | ||
- [auth-code](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/auth-code): Express app using OAuth2.0 authorization code flow. | ||
- [auth-code-pkce](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/auth-code-pkce): Express app using OAuth2.0 authorization code flow with PKCE. | ||
- [device-code](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/device-code): Command line app using OAuth 2.0 device code flow. | ||
- [refresh-token](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/refresh-token): Command line app using OAuth 2.0 refresh flow. | ||
- [silent-flow](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/silent-flow): Express app using OAuth2.0 authorization code flow to acquire a token and store in the token cache, and silent flow to use tokens in the token cache. | ||
- [client-credentials](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/client-credentials): Daemon app using OAuth 2.0 client credential grant to acquire a token. | ||
- [on-behalf-of](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/on-behalf-of): Web application using OAuth 2.0 auth code flow to acquire a token for a web API. The web API validates the token, and calls Microsoft Graph on behalf of the user who authenticated in the web application. | ||
- [username-password](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/username-password): Web application using OAuth 2.0 resource owner password credentials (ROPC) flow to acquire a token for a web API. | ||
- [ElectronTestApp](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/ElectronTestApp): Electron desktop application using OAuth 2.0 auth code with PKCE flow to acquire a token for a web API such as Microsoft Graph. | ||
- [Hybrid Spa Sample](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-browser-samples/HybridSample): Sample demonstrating how to use `enableSpaAuthorizationCode` to perform SSO for applications that leverage server-side and client-side authentication using MSAL Browser and MSAL Node. | ||
B2C samples: | ||
- [b2c-user-flows](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/b2c-user-flows): Express app using OAuth2.0 authorization code flow. | ||
- [b2c-user-flows](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/samples/msal-node-samples/b2c-user-flows): Express app using OAuth2.0 authorization code flow. | ||
Others: | ||
- [msal-node-extensions](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/extensions/samples/msal-node-extensions): Uses authorization code flow to acquire tokens and the [msal-extensions](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/extensions/) library to write the MSAL in-memory token cache to disk. | ||
- [msal-node-extensions](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/extensions/samples/msal-node-extensions): Uses authorization code flow to acquire tokens and the [msal-extensions](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/extensions/) library to write the MSAL in-memory token cache to disk. | ||
@@ -151,8 +156,11 @@ ## Build and Test | ||
### Local Development | ||
Below is a list of commands you will probably find useful: | ||
#### `npm run build:modules:watch` | ||
Runs the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab. The library will be rebuilt if you make edits. | ||
#### `npm run build` | ||
Bundles the package to the `dist` folder. | ||
@@ -162,8 +170,11 @@ The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module). | ||
#### `npm run build:all` | ||
Builds both `msal-common` and `msal-node` | ||
#### `npm run lint` | ||
Runs eslint with Prettier | ||
#### `npm test`, `npm run test:coverage`, `npm run test:watch` | ||
Runs the test watcher (Jest) in an interactive mode. | ||
@@ -179,3 +190,3 @@ By default, runs tests related to files changed since the last commit. | ||
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. | ||
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. | ||
@@ -182,0 +193,0 @@ ## We Value and Adhere to the Microsoft Open Source Code of Conduct |
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
625482
187
7
+ Added@azure/msal-common@14.0.1(transitive)
- Removed@azure/msal-common@14.0.0(transitive)
Updated@azure/msal-common@14.0.1