@mybiogen/auth-openid - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "@mybiogen/auth-openid",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Authorization for OpenID",
@@ -35,3 +35,3 @@ "license": "MIT",
   },
-  "gitHead": "7ba167c37df2b2664d19789b5f6f035100156c69"
+  "gitHead": "0134124240b8735dda29196b6d57a4c4db921f6c"
 }

README.md

@@ -1,1 +0,31 @@
-# auth-openid
+# auth-openid
+
+## Quickstart
+
+#### 1. Install (assuming the private npm registry is already set up)
+
+`yarn add @mybiogen/open-authid`
+
+#### 2. Create JanrainJS instance.
+
+```
+import JanrainJS from '@mybiogen/open-authid'
+
+const janrain = new JanrainJS(JANRAIN_CLIENT_ID, JANRAIN_CONFIG_URL, JANRAIN_REDIRECT_URI)
+```
+
+Note: `JANRAIN_CLIENT_ID`, `JANRAIN_CONFIG_URL` and `JANRAIN_REDIRECT_URI` are required params.
+
+## API Summary
+
+|  |  |  |
+| --- | --- | --- |
+| `janrain.login()` | `(): void` | User login method. |
+| `janrain.logout()` | `async (): Promise<void>` | User logout method. |
+| `janrain.watchAuth(callback)` | `async (cb: WatchAuthCallback): Promise<void>` | Method for watching the changes in authentication status. |
+| `janrain.getUserInfo()` | `async (): Promise<JanrainUserInfo or undefined>`| Method for retrieving user information. |
+| `janrain.refreshToken()` | `async (): Promise<Init or undefined>` | Method for refreshing authentication token. |
+
+## Available types
+
+`import { Token, JanrainUserInfo, WatchAuthCallback, Init, ConfigEndpoint } from '@mybiogen/open-authid';`

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

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

Network access

Supply chain risk

This module accesses the network.

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

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

76590

increased by8754.34%

Number of package files

42

increased by1300%

Lines of code

614

increased byInfinity%

Number of lines in readme file

31

increased by3000%

Worsened metrics

Number of medium supply chain risk alerts

6

increased by200%

No dependency changes