@azure/core-auth - npm Package Compare versions

Comparing version 1.0.0-preview.4 to 1.0.0

Changelog.md

 # Changelog
 
+# 1.0.0 - 2019-10-29
+
+This release marks the general availability of the `@azure/core-auth` package.
+
+- Standardizes API to be more consistent with other SDK packages.
+  ([PR #5899](https://github.com/Azure/azure-sdk-for-js/pull/5899))
+- Removed the browser bundle. A browser-compatible library can still be created through the use of a bundler such as Rollup, Webpack, or Parcel.
+  ([#5860](https://github.com/Azure/azure-sdk-for-js/pull/5860))
+
 # 1.0.0-preview.4 - 2019-10-22
@@ -4,0 +13,0 @@

package.json

 {
   "name": "@azure/core-auth",
-  "version": "1.0.0-preview.4",
+  "version": "1.0.0",
   "description": "Provides low-level interfaces and helper methods for authentication in Azure SDK",
@@ -8,5 +8,2 @@ "sdk-type": "client",
   "module": "dist-esm/src/index.js",
-  "browser": {
-    "./dist/index.js": "./browser/core-auth.js"
-  },
   "types": "types/core-auth.d.ts",
@@ -39,3 +36,2 @@ "scripts": {
   "files": [
-    "browser/*.js*",
     "dist/",
@@ -62,3 +58,3 @@ "dist-esm/src/",
   "dependencies": {
-    "@azure/abort-controller": "1.0.0-preview.2",
+    "@azure/abort-controller": "^1.0.0",
     "@azure/core-tracing": "1.0.0-preview.5",
@@ -82,3 +78,3 @@ "tslib": "^1.9.3"
     "inherits": "^2.0.3",
-    "mocha": "^6.2.0",
+    "mocha": "^6.2.2",
     "mocha-junit-reporter": "^1.18.0",
@@ -85,0 +81,0 @@ "mocha-multi": "^1.1.3",

README.md

@@ -15,3 +15,3 @@ ## Azure Core Authentication
 
-If you'd like to contribute to this library, please read the [contributing guide](../../../CONTRIBUTING.md) to learn more about how to build and test the code.
+If you'd like to contribute to this library, please read the [contributing guide](https://github.com/Azure/azure-sdk-for-js/tree/64a0cf353678b313bc1c27b430803db431e49c4e/CONTRIBUTING.md) to learn more about how to build and test the code.
 
@@ -18,0 +18,0 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).

src/index.ts

@@ -11,2 +11,8 @@ // Copyright (c) Microsoft Corporation. All rights reserved.
 
+export {
+  OperationOptions,
+  OperationTracingOptions,
+  OperationRequestOptions
+} from "./operationOptions";
+
 export { AbortSignalLike } from '@azure/abort-controller';

src/tokenCredential.ts

@@ -5,3 +5,3 @@ // Copyright (c) Microsoft Corporation.
 import { AbortSignalLike } from "@azure/abort-controller";
-import { SpanOptions } from "@azure/core-tracing";
+import { OperationOptions } from "./operationOptions";
 
@@ -25,16 +25,3 @@ /**
  */
-export interface GetTokenOptions {
-  /**
-   * An AbortSignalLike implementation that can be used to cancel
-   * the token request.
-   */
-  abortSignal?: AbortSignalLike;
-  /**
-   * Timeout for pinging services
-   */
-  timeout?: number;
-  /**
-   * Options to create a span using the tracer if any was set.
-   */
-  spanOptions?: SpanOptions;
+export interface GetTokenOptions extends OperationOptions {
 }
@@ -47,3 +34,3 @@
   /**
-   * The access token.
+   * The access token returned by the authentication service.
    */
@@ -53,3 +40,3 @@ token: string;
   /**
-   * The access token's expiration timestamp.
+   * The access token's expiration timestamp in milliseconds, UNIX epoch time.
    */
@@ -56,0 +43,0 @@ expiresOnTimestamp: number;

types/core-auth.d.ts

@@ -10,7 +10,7 @@ import { AbortSignalLike } from '@azure/abort-controller';
     /**
-     * The access token.
+     * The access token returned by the authentication service.
      */
     token: string;
     /**
-     * The access token's expiration timestamp.
+     * The access token's expiration timestamp in milliseconds, UNIX epoch time.
      */
@@ -23,14 +23,40 @@ expiresOnTimestamp: number;
  */
-export declare interface GetTokenOptions {
+export declare interface GetTokenOptions extends OperationOptions {
+}
+
+/**
+ * Tests an object to determine whether it implements TokenCredential.
+ *
+ * @param credential The assumed TokenCredential to be tested.
+ */
+export declare function isTokenCredential(credential: any): credential is TokenCredential;
+
+/**
+ * The base options type for all operations.
+ */
+export declare interface OperationOptions {
     /**
-     * An AbortSignalLike implementation that can be used to cancel
-     * the token request.
+     * The signal which can be used to abort requests.
      */
     abortSignal?: AbortSignalLike;
     /**
-     * Timeout for pinging services
+     * Options used when creating and sending HTTP requests for this operation.
      */
+    requestOptions?: OperationRequestOptions;
+    /**
+     * Options used when tracing is enabled.
+     */
+    tracingOptions?: OperationTracingOptions;
+}
+
+export declare interface OperationRequestOptions {
+    /**
+     * The number of milliseconds a request can take before automatically being terminated.
+     */
     timeout?: number;
+}
+
+export declare interface OperationTracingOptions {
     /**
-     * Options to create a span using the tracer if any was set.
+     * OpenTelemetry SpanOptions used to create a span when tracing is enabled.
      */
@@ -41,9 +67,2 @@ spanOptions?: SpanOptions;
 /**
- * Tests an object to determine whether it implements TokenCredential.
- *
- * @param credential The assumed TokenCredential to be tested.
- */
-export declare function isTokenCredential(credential: any): credential is TokenCredential;
-
-/**
  * Represents a credential capable of providing an authentication token.
@@ -50,0 +69,0 @@ */

Fixed alerts

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

Lines of code

212

increased by7.07%

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

16776

decreased by-22.18%

Number of package files

15

decreased by-6.25%

Dependency changes

• + Added@azure/abort-controller@1.1.0(transitive)

• + Addedtslib@2.6.3(transitive)

• - Removed@azure/abort-controller@1.0.0-preview.2(transitive)

• Updated@azure/abort-controller@^1.0.0