stytch - npm Package Compare versions

Comparing version 3.0.0 to 3.0.1

package.json

 {
   "name": "stytch",
-  "version": "3.0.0",
+  "version": "3.0.1",
   "description": "A wrapper for the Stytch API",
@@ -5,0 +5,0 @@ "types": "./types/lib/index.d.ts",

README.md

@@ -1,41 +0,48 @@
-# stytch-node
+# Stytch Node.js Library
 
-The Stytch Node library provides support for the Stytch API for server-side Javscript
-applications. You can find out more about the Stytch API at
-[stytch.com/docs](https://stytch.com/docs).
+The Stytch Node library makes it easy to use the Stytch user infrastructure API in server-side JavaScript applications.
 
-If you're looking for frontend support for our Javascript SDK, check out
-[stytch-js](https://www.npmjs.com/package/@stytch/stytch-js).
+It pairs well with the Stytch [Web SDK](https://www.npmjs.com/package/@stytch/stytch-js) or your own custom authentication flow.
 
-## Quickstart
+## Install
 
-Install stytch
 ```
 npm install stytch
+# or
+yarn add stytch
 ```
 
-Run `login_or_create` to send a magic link by email:
+## Usage
 
+You can find your API credentials in the [Stytch Dashboard](https://stytch.com/dashboard/api-keys).
+
+Create an API client:
 ```javascript
-import * as stytch from "stytch";
-// Or as a CommonJS module:
-// const stytch = require("stytch");
+const stytch = require("stytch");
+// Or as an ES6 module:
+// import * as stytch from "stytch";
 
 const client = new stytch.Client({
-  project_id: "PROJECT_ID",
-  secret: "SECRET",
+  project_id: "project-live-c60c0abe-c25a-4472-a9ed-320c6667d317",
+  secret: "secret-live-80JASucyk7z_G8Z-7dVwZVGXL5NT_qGAQ2I=",
   env: stytch.envs.test,
 });
+```
 
+Send a magic link by email:
+```javascript
 client.magicLinks.email
   .loginOrCreate({
     email: "[e-mail]",
-    login_magic_link_url: "http://localhost:8000/login",
-    signup_magic_link_url: "http://localhost:8000/signup",
+    login_magic_link_url: "https://example.com/authenticate",
+    signup_magic_link_url: "https://example.com/authenticate",
   })
   .then((res) => console.log(res))
   .catch((err) => console.error(err));
+```
 
+Authenticate the token from the magic link:
+```javascript
 client.magicLinks
-  .authenticate("TOKEN FROM EMAIL")
+  .authenticate("DOYoip3rvIMMW5lgItikFK-Ak1CfMsgjuiCyI7uuU94=")
   .then((res) => console.log(res))
@@ -45,6 +52,37 @@ .catch((err) => console.error(err));
 
+## Handling Errors
+
+Stytch errors always include an `error_type` field you can use to identify them:
+```javascript
+client.magicLinks
+  .authenticate("not-a-token!")
+  .then((res) => console.log(res))
+  .catch((err) => {
+    if (err.error_type === "invalid_token") {
+      console.log("Whoops! Try again?");
+    }
+  });
+```
+Learn more about errors in the [docs](https://stytch.com/docs/api/errors).
+
 ## Documentation
 
-You can find all the documentation at https://stytch.com/docs, including an
-[API reference](https://stytch.com/docs/api) with example usage for every endpoint.  We also
-maintain a set of [example apps](https://stytch.com/docs/example-apps) to start development from.
+See example requests and responses for all the endpoints in the [Stytch API Reference](https://stytch.com/docs/api).
+
+Follow one of the [integration guides](https://stytch.com/docs/guides) or start with one of our [example apps](https://stytch.com/docs/example-apps).
+
+## Support
+
+If you've found a bug, [open an issue](https://github.com/stytchauth/stytch-node/issues/new)!
+
+If you have questions or want help troubleshooting, join us in [Slack](https://join.slack.com/t/stytch/shared_invite/zt-nil4wo92-jApJ9Cl32cJbEd9esKkvyg) or email [e-mail].
+
+If you've found a security vulnerability, please follow our [responsible disclosure instructions](https://stytch.com/docs/security).
+
+## Development
+
+See [DEVELOPMENT.md](DEVELOPMENT.md)
+
+## Code of Conduct
+
+Everyone interacting in the Stytch project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](CODE_OF_CONDUCT.md).

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

Improved metrics

Total package byte prevSize

31091

increased by4.38%

Number of lines in readme file

88

increased by76%

No dependency changes