@azure/msal-common - npm Package Compare versions

Comparing version 1.0.0-beta.4 to 1.0.0

changelog.md

@@ -0,1 +1,12 @@
+# 1.0.0
+## Breaking Changes
+- None
+
+## Features and Fixes
+- Fixed an issue where scopes were being made lower case before being sent to the service (#1961)
+- Fix an issue where token values were replaced with undefined if not sent by server (#1946)
+- Fix an issue where cache lookup for accounts was not working correctly (#1919)
+- Removed TelemetryOptions from msal-common since they were unused (#1983)
+- Add a response handler for the device code flow (#1947)
+
 # 1.0.0-beta.4
@@ -2,0 +13,0 @@ ## Breaking Changes

dist/src/cache/CacheManager.d.ts

@@ -111,2 +111,10 @@ import { AccountCache, AccountFilter, CredentialFilter, CredentialCache } from "./utils/CacheTypes";
     /**
+     * Removes all app metadata objects from cache.
+     */
+    removeAppMetadata(): boolean;
+    /**
+     * Removes all accounts and related tokens from cache.
+     */
+    removeAllAccounts(): boolean;
+    /**
      * returns a boolean if the given account is removed
@@ -163,2 +171,7 @@ * @param account
     /**
+     * Returns a valid AccountEntity if key and object contain correct values, null otherwise.
+     * @param key
+     */
+    private getAccountEntity;
+    /**
      * returns if a given cache entity is of the type appmetadata
@@ -165,0 +178,0 @@ * @param key

dist/src/cache/interface/ICacheManager.d.ts

@@ -44,2 +44,6 @@ import { CredentialEntity } from "../entities/CredentialEntity";
     /**
+     * Removes all accounts and related tokens from cache.
+     */
+    removeAllAccounts(): boolean;
+    /**
      * returns a boolean if the given account is removed
@@ -46,0 +50,0 @@ * @param account

dist/src/client/DeviceCodeClient.d.ts

 import { BaseClient } from "./BaseClient";
 import { DeviceCodeRequest } from "../request/DeviceCodeRequest";
 import { ClientConfiguration } from "../config/ClientConfiguration";
+import { AuthenticationResult } from "../response/AuthenticationResult";
 /**
@@ -14,3 +15,3 @@ * OAuth2.0 Device code client
      */
-    acquireToken(request: DeviceCodeRequest): Promise<string>;
+    acquireToken(request: DeviceCodeRequest): Promise<AuthenticationResult>;
     /**
@@ -17,0 +18,0 @@ * Creates device code request and executes http GET

dist/src/config/ClientConfiguration.d.ts

@@ -28,3 +28,3 @@ import { INetworkModule } from "../network/INetworkModule";
 /**
- * Use this to configure the auth options in the Configuration object
+ * Use this to configure the auth options in the ClientConfiguration object
  *
@@ -43,20 +43,8 @@ * - clientId                    - Client ID of your app registered with our Application registration portal : https://portal.azure.com/#blade/Microsoft_AAD_IAM/ActiveDirectoryMenuBlade/RegisteredAppsPreview in Microsoft Identity Platform
 /**
- * Use this to configure the telemetry options in the Configuration object
+ * Use this to configure token renewal info in the Configuration object
  *
- * - applicationName              - Name of the consuming apps application
- * - applicationVersion           - Version of the consuming application
- */
-export declare type TelemetryOptions = {
-    applicationName: string;
-    applicationVersion: string;
-};
-/**
- * Use this to configure token renewal and telemetry info in the Configuration object
- *
  * - tokenRenewalOffsetSeconds    - Sets the window of offset needed to renew the token before expiry
- * - telemetry                    - Telemetry options for library network requests
  */
 export declare type SystemOptions = {
     tokenRenewalOffsetSeconds?: number;
-    telemetry?: TelemetryOptions;
 };
@@ -63,0 +51,0 @@ /**

dist/src/index.d.ts

@@ -5,3 +5,3 @@ export { AuthorizationCodeClient } from "./client/AuthorizationCodeClient";
 export { SilentFlowClient } from "./client/SilentFlowClient";
-export { AuthOptions, SystemOptions, LoggerOptions, TelemetryOptions, DEFAULT_SYSTEM_OPTIONS } from "./config/ClientConfiguration";
+export { AuthOptions, SystemOptions, LoggerOptions, DEFAULT_SYSTEM_OPTIONS } from "./config/ClientConfiguration";
 export { ClientConfiguration } from "./config/ClientConfiguration";
@@ -8,0 +8,0 @@ export { AccountInfo } from "./account/AccountInfo";

dist/src/request/EndSessionRequest.d.ts

 import { AccountInfo } from "../account/AccountInfo";
+/**
+ * EndSessionRequest
+ * - account                - Account object that will be logged out of. All tokens tied to this account will be cleared.
+ * - postLogoutRedirectUri  - URI to navigate to after logout page.
+ * - authority              - Authority to send logout request to.
+ * - correlationId          - Unique GUID set per request to trace a request end-to-end for telemetry purposes.
+ */
 export declare type EndSessionRequest = {
@@ -3,0 +10,0 @@ account?: AccountInfo;

dist/src/request/RefreshTokenRequest.d.ts

@@ -8,3 +8,2 @@ import { BaseAuthRequest } from "./BaseAuthRequest";
  * - refreshToken            - A refresh token returned from a previous request to the Identity provider.
- * - redirectUri             - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
  */
@@ -11,0 +10,0 @@ export declare type RefreshTokenRequest = BaseAuthRequest & {

dist/src/request/ScopeSet.d.ts

 /**
  * The ScopeSet class creates a set of scopes. Scopes are case-insensitive, unique values, so the Set object in JS makes
- * the most sense to implement for this class. All scopes are trimmed and converted to lower case strings to ensure uniqueness of strings.
+ * the most sense to implement for this class. All scopes are trimmed and converted to lower case strings in intersection and union functions
+ * to ensure uniqueness of strings.
  */
@@ -68,2 +69,6 @@ export declare class ScopeSet {
     printScopes(): string;
+    /**
+     * Prints scopes into a space-delimited lower-case string (used for caching)
+     */
+    printScopesLowerCase(): string;
 }

dist/src/request/SilentFlowRequest.d.ts

@@ -10,3 +10,2 @@ import { AccountInfo } from "../account/AccountInfo";
  * - forceRefresh           - Forces silent requests to make network calls if true.
- * - redirectUri            - The redirect URI where authentication responses can be received by your application. It must exactly match one of the redirect URIs registered in the Azure portal.
  */
@@ -13,0 +12,0 @@ export declare type SilentFlowRequest = BaseAuthRequest & {

dist/src/utils/StringUtils.d.ts

@@ -27,7 +27,7 @@ import { DecodedJwt } from "../account/DecodedJwt";
     /**
-     * Trims entries and converts them to lower case.
+     * Trims entries in an array.
      *
      * @param arr
      */
-    static trimAndConvertArrayEntriesToLowerCase(arr: Array<string>): Array<string>;
+    static trimArrayEntries(arr: Array<string>): Array<string>;
     /**
@@ -34,0 +34,0 @@ * Removes empty strings from array

package.json

@@ -13,3 +13,3 @@ {
     },
-    "version": "1.0.0-beta.4",
+    "version": "1.0.0",
     "description": "Microsoft Authentication Library for js",
@@ -16,0 +16,0 @@ "keywords": [

README.md

@@ -1,2 +0,2 @@
-# (Preview) Microsoft Authentication Library for JavaScript (MSAL.js) Common Package
+# Microsoft Authentication Library for JavaScript (MSAL.js) Common Protocols Package
 [![npm version](https://img.shields.io/npm/v/@azure/msal-common.svg?style=flat)](https://www.npmjs.com/package/@azure/msal-common/)[![npm version](https://img.shields.io/npm/dm/@azure/msal-common.svg)](https://nodei.co/npm/@azure/msal-common/)[![Coverage Status](https://coveralls.io/repos/github/AzureAD/microsoft-authentication-library-for-js/badge.svg?branch=dev)](https://coveralls.io/github/AzureAD/microsoft-authentication-library-for-js?branch=dev)
@@ -20,3 +20,3 @@
 
-The `@azure/msal-common` package described by the code in this folder serves as a common package dependency for the `@azure/msal-browser` package (and in the future, the msal-node package). **It is not meant for production consumption by itself.**
+The `@azure/msal-common` package described by the code in this folder serves as a common package dependency for the `@azure/msal-browser` package (and in the future, the msal-node package). Be aware that this is an internal library, and is subject to frequent change. **It is not meant for production consumption by itself.**
 
@@ -33,3 +33,3 @@ ## FAQ
 | ------| ------- | ---------| --------- |
-| July 13, 2020 (Tentative) | @azure/msal-common v2.0.0 | Full release version of the `@azure/msal-common` |
+| July 20, 2020 | @azure/msal-common v2.0.0 | [Release Notes](https://github.com/AzureAD/microsoft-authentication-library-for-js/releases/tag/msal-common-v1.0.0) | Full release version of the `@azure/msal-common` |
 | May 11, 2020 | @azure/msal-common v2.0.0-beta | Beta version of the `@azure/msal-common` package |
@@ -42,2 +42,3 @@ | January 17, 2020 | @azure/msal-common v1.0.0-alpha | No release notes yet | Alpha version of the `@azure/msal-common` package with authorization code flow for SPAs working in dev. |
 - [MSAL for Single Page Applications (SPAs)](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-browser)
+- [MSAL for Node.js](https://github.com/AzureAD/microsoft-authentication-library-for-js/tree/dev/lib/msal-node)
 
@@ -44,0 +45,0 @@ ## Installation

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1192160

increased by1.56%

Lines of code

13830

increased by1.51%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

58

increased by1.75%

No dependency changes