web-auth-library - npm Package Compare versions

Comparing version 0.3.0 to 0.3.1

dist/gcp/auth.d.ts

 import { Credentials } from "./credentials.js";
-declare type AuthTokenOptions<T extends "accessToken" | "idToken"> = T extends "accessToken" ? {
+declare type AccessTokenOptions = {
     credentials: Credentials | string;
-    scope: string[] | string;
-    audience?: never;
-} : {
+    scope?: string[] | string;
+};
+declare type IdTokenOptions = {
     credentials: Credentials | string;
     audience: string;
-    scope?: never;
 };
@@ -33,4 +32,5 @@ declare type AccessToken = {
  */
-declare function getAuthToken<T extends AuthTokenOptions<"accessToken"> | AuthTokenOptions<"idToken">>(options: T): Promise<T extends AuthTokenOptions<"accessToken"> ? AccessToken : IdToken>;
+declare function getAuthToken(options: AccessTokenOptions): Promise<AccessToken>;
+declare function getAuthToken(options: IdTokenOptions): Promise<IdToken>;
 export declare function fetchAuthToken(credentials: Credentials, scope: string | undefined): Promise<AccessToken | IdToken>;
 export { type AccessToken, type IdToken, getAuthToken };

dist/gcp/auth.js

@@ -1,2 +0,2 @@
-/* SPDX-FileCopyrightText: 2020-present Kriasoft */
+/* SPDX-FileCopyrightText: 2022-present Kriasoft */
 /* SPDX-License-Identifier: MIT */
@@ -10,19 +10,10 @@ import QuickLRU from "quick-lru";
 });
-/**
- * Retrieves an authentication token from OAuth 2.0 authorization server.
- *
- * @example
- *   const token = await getAuthToken({
- *     credentials: env.GOOGLE_CLOUD_CREDENTIALS,
- *     scope: "https://www.googleapis.com/auth/cloud-platform"
- *   );
- *   const headers = { Authorization: `Bearer ${token.accessToken}` };
- *   const res = await fetch(url, { headers });
- */
 async function getAuthToken(options) {
     // Normalize input arguments
     const credentials = getCredentials(options.credentials);
-    const scope = "scope" in options && Array.isArray(options.scope)
-        ? options.scope.sort().join(" ")
-        : options.scope ?? options.audience;
+    const scope = "scope" in options || !("audience" in options)
+        ? Array.isArray(options.scope)
+            ? options.scope.sort().join(" ")
+            : options.scope
+        : options.audience;
     // Attempt to retrieve the token from the cache
@@ -29,0 +20,0 @@ const keyId = credentials?.private_key_id ?? credentials.client_email;

package.json

 {
   "name": "web-auth-library",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "packageManager": "yarn@4.0.0-rc.6",
@@ -12,2 +12,19 @@ "description": "Authentication library for the browser environment using Web Crypto API",
   },
+  "contributors": [
+    {
+      "name": "Konstantin Tarkus",
+      "email": "[e-mail]",
+      "url": "https://github.com/koistya"
+    }
+  ],
+  "funding": [
+    {
+      "type": "github",
+      "url": "https://github.com/sponsors/kriasoft"
+    },
+    {
+      "type": "patreon",
+      "url": "https://www.patreon.com/koistya"
+    }
+  ],
   "repository": "kriasoft/web-auth-library",
@@ -14,0 +31,0 @@ "keywords": [

README.md

@@ -53,6 +53,7 @@ # Authentication Library for the Web Environment
 
+#### Generating an ID token for the arbitrary resource
+
 ```ts
 import { getAuthToken, importKey, sign } from "web-auth-library/gcp";
 
-// Get an ID token for the target resource (audience)
 const token = await getAuthToken({
@@ -67,8 +68,11 @@ credentials: env.GOOGLE_CLOUD_CREDENTIALS,
 // }
+```
 
-// Convert GCP service account key into `CryptoKey` object
-const credentials = JSON.parse(env.GOOGLE_CLOUD_CREDENTIALS);
+#### Generating a digital signature
+
+```ts
+import { getCredentials, importKey, sign } from "web-auth-library/gcp";
+
+const credentials = getCredentials(env.GOOGLE_CLOUD_CREDENTIALS);
 const signingKey = await importKey(credentials.private_key, ["sign"]);
-
-// Generate a digital signature
 const signature = await sign(signingKey, "xxx");
@@ -75,0 +79,0 @@ ```

Fixed alerts

Major refactor

Supply chain risk

Package 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

Improved metrics

Total package byte prevSize

14729

0.72%

Number of package files

13

18.18%

Number of lines in readme file

103

4.04%

Number of medium supply chain risk alerts

1

-50%

Worsened metrics

Lines of code

198

-2.46%

No dependency changes