npm - @slashid/remix - Versions diffs - 0.1.2 → 0.1.4 - Mend

@slashid/remix 0.1.2 → 0.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md CHANGED Viewed

@@ -1,4 +1,4 @@
-![SlashID Remix SDK](https://raw.githubusercontent.com/slashid/javascript/main/packages/remix/banner.png)
+![SlashID Remix SDK](https://raw.githubusercontent.com/slashid/javascript/main/packages/remix/slashid_remix_banner.png)
 ![npm](https://img.shields.io/npm/v/@slashid/remix)
 ![build](https://github.com/slashid/javascript/actions/workflows/ci.yml/badge.svg)
@@ -7,46 +7,37 @@
 Check out our [developer docs](https://developer.slashid.dev/) for guides and API documentation.
-## Setup
+## Quick Start
-### Prerequisites
+`@slashid/remix` requires Remix v2.
-You will need to [sign up to SlashID](https://console.slashid.dev/) and create an organization, once you've complete this you'll find your organization ID in [Settings -> General](https://console.slashid.dev/settings/general).
-Your environment should have the following dependencies installed:
-- `node.js` => `>=20.x.x`
-- `react` => `>=18.x.x`
-### Quick start
-#### 1. Install `@slashid/remix`
+You will need to [sign up to SlashID](https://console.slashid.dev/) and create an organization, once you've done this you'll find your organization ID in [Settings -> General](https://console.slashid.dev/settings/general).
+### 1. Install `@slashid/remix`
 Once you have a Remix application ready to go, you need to install the SlashID Remix SDK. This SDK provides a prebuilt log-in & sign-up form, control components and hooks - tailor made for Remix.
 ```
 npm install @slashid/remix
 ```
-#### 2. Create SlashID app primitives
+### 2. Create SlashID app primitives
 In your Remix application create a file `app/slashid.ts`.
 In this file create the SlashID application primitives and re-export them, you'll use them later.
 ```ts
 // app/slashid.ts
-import { createSlashIDApp } from "@slashid/remix";
+import { createSlashIDApp } from '@slashid/remix'
-export const { SlashIDApp, slashIDRootLoader, slashIDLoader } =
-  createSlashIDApp({ oid: "YOUR_ORGANIZATION_ID" });
-```
+export const {
+  SlashIDApp,
+  slashIDRootLoader,
+  slashIDLoader
+} = createSlashIDApp({ oid: "YOUR_ORGANIZATION_ID" });
+```
 Tip: `oid` is your organization ID, you can find it in the [SlashID console](https://console.slashid.dev/) under [Settings -> General](https://console.slashid.dev/settings/general).
-#### 3. Configure `slashIDRootLoader`
+### 3. Configure `slashIDRootLoader`
 To configure SlashID in your Remix application you'll need to update your root loader. With a small change you'll have easy access to authentication in all of your Remix routes.
 Import the `slashIDRootLoader` you created in the previous step, invoke it and export it as `loader`.
@@ -66,9 +57,9 @@ import {
 } from "@remix-run/react";
 import { slashIDRootLoader } from "~/slashid";
 export const loader: LoaderFunction = slashIDRootLoader();
 export default function App() {
   return (
     <html lang="en">
@@ -94,11 +85,11 @@ If you need to load additional data via the root loader, you can simply pass a l
 ```ts
 // root.ts
-import { slashIDRootLoader } from "~/slashid";
-import { getUser } from "@slashid/remix";
+import { slashIDRootLoader } from "~/slashid"
+import { getUser } from '@slashid/remix'
 export const loader: LoaderFunction = slashIDRootLoader((args) => {
-  const user = getUser(args);
+  const user = getUser(args)
   if (user) {
     // the user is logged in
@@ -107,19 +98,18 @@ export const loader: LoaderFunction = slashIDRootLoader((args) => {
   // fetch data
   return {
-    hello: "world!", // your data
-  };
+    hello: "world!" // your data
+  }
 });
 ```
-#### 4. Wrap your application body with `<SlashIDApp>`
+### 4. Wrap your application body with `<SlashIDApp>`
 In step 2 you created `SlashIDApp`, it provides authentication state to your React component tree. There is no configuration, just add it to your Remix application.
 ```tsx
 // root.tsx
-import { SlashIDApp } from "~/slashid";
+import { SlashIDApp } from '~/slashid'
 export default function App() {
   return (
@@ -144,16 +134,21 @@ export default function App() {
 }
 ```
-#### 5. Create your log-in/sign-up page
+### 5. Create your log-in/sign-up page
 SlashID offers a prebuilt form that works for both log-in and sign-up. Users with an account can log-in here and users without one need to simply complete the form to create their account.
 ```tsx
 // routes/login.tsx
-import { ConfigurationProvider, Form, type Factor } from "@slashid/remix";
+import {
+  ConfigurationProvider,
+  Form,
+  type Factor,
+} from "@slashid/remix";
-const factors: Factor[] = [{ method: "email_link" }];
+const factors: Factor[] = [
+  { method: "email_link" }
+];
 export default function LogIn() {
   return (
@@ -166,10 +161,28 @@ export default function LogIn() {
 }
 ```
-#### 6. Protecting your pages
+After the user has logged in, you might want to redirect them to another page. You can this with a loader.
-##### Server side
+When authentication has complete the form will tell the loader to run again, refreshing the authentication context, and triggering the redirect.
+```tsx
+// routes/login.tsx
+import { slashIDLoader } from '~/slashid'
+export const loader = slashIDLoader((args) => {
+  const user = getUser(args)
+  if (user) {
+    return redirect("index") // redirect to your desired destination
+  }
+  return {}
+})
+```
+### 6. Protecting your pages
+#### Server side
 To protect your routes you can use the `slashIDLoader` you created in step 2. This utility is a wrapper for your loaders that provides authentication state to your loader code.
 You'll check if the user exists, and if not redirect them to the login page.
@@ -179,34 +192,35 @@ The `useSlashID()` hook provides authentication state & helper functions to your
 ```tsx
 // routes/_index.tsx
-import { slashIDLoader } from "~/slashid";
-import { getUser, useSlashID } from "@slashid/remix";
+import { slashIDLoader } from '~/slashid'
+import { getUser, useSlashID } from '@slashid/remix'
 export const loader = slashIDLoader((args) => {
-  const user = getUser(args);
+  const user = getUser(args)
   if (!user) {
-    return redirect("login");
+    return redirect("login")
   }
-  return {};
-});
+  return {}
+})
 export default function Index() {
-  const { logOut } = useSlashID();
+  const { logOut } = useSlashID()
   return (
     <div>
       <h1>Index</h1>
       <p>You are logged in!</p>
-      <button onClick={logOut}>Log out</button>
+      <button onClick={logOut}>
+        Log out
+      </button>
     </div>
-  );
+  )
 }
 ```
-##### Client side
+#### Client side
 SlashID has several [Control Components](https://developer.slashid.dev/docs/access/react-sdk/reference/components/react-sdk-reference-loggedin) that allow you to conditionally show or hide content based on the users authentication state.
 You'll implement `<LoggedIn>`, `<LoggedOut>`, and provide the option to log-out by implementing the `logOut` helper function from the `useSlashID()` hook.
@@ -214,21 +228,25 @@ You'll implement `<LoggedIn>`, `<LoggedOut>`, and provide the option to log-out
 ```tsx
 // routes/_index.tsx
-import { LoggedIn, LoggedOut, useSlashID } from "@slashid/remix";
+import { LoggedIn, LoggedOut, useSlashID } from '@slashid/remix'
 import { useNavigate } from "@remix-run/react";
 export default function Index() {
-  const { logOut } = useSlashID();
+  const { logOut } = useSlashID()
   const navigate = useNavigate();
   return (
     <div>
       <LoggedIn>
         You are logged in!
-        <button onClick={logOut}>Log out</button>
+        <button onClick={logOut}>
+          Log out
+        </button>
       </LoggedIn>
-      <LoggedOut>{navigate("login")}</LoggedOut>
+      <LoggedOut>
+        {navigate("login")}
+      </LoggedOut>
     </div>
-  );
+  )
 }
 ```