@frontegg/nextjs 6.5.0-alpha.3076979339 → 6.5.0

package/README.md

@@ -1,248 +1,7 @@
-![alt text](./logo.png)
+# nextjs
 
-Frontegg is a web platform where SaaS companies can set up their fully managed, scalable and brand aware - SaaS features
-and integrate them into their SaaS portals in up to 5 lines of code.
+This library was generated with [Nx](https://nx.dev).
 
-## Table of Contents
+## Running unit tests
 
-- [Installation](#installation)
-  - [Create new NextJS project](#create-new-nextjs-project)
-  - [Add to existing project](#add-to-existing-project)
-- [Getting Started](#getting-started)
-  - [Create Frontegg worksapce](#create-frontegg-worksapce)
-  - [Setup environment](#setup-environment)
-- [Documentation](#documentation)
-  - [API Reference](#api-reference)
-  - [Frontegg Provider Options](#frontegg-provider-options)
-  - [getSession](#getsession)
-  - [withSSRSession](#withssrsession)
-  - [Next.js middlewares usage](#nextjs-middlewares-usage)
-  - for more [visit](https://docs.frontegg.com/docs/self-service-introduction)
-
-## Installation
-
-### Create new NextJS project
-
-To start a new Create Next App project with TypeScript, you can run:
-
-```bash
-  npx create-next-app --example "https://github.com/frontegg/frontegg-nextjs" --example-path "apps/example" my-nextjs-app-name
-```
-
-or
-
-```bash
-  yarn create next-app --example "https://github.com/frontegg/frontegg-nextjs" --example-path "apps/example" my-nextjs-app-name
-```
-
-> If you've previously installed `create-react-app` globally via `npm install -g create-next-app`, we recommend you uninstall the package using `npm uninstall -g create-next-app` or `yarn global remove create-next-app` to ensure that `npx` always uses the latest version.
->
-> Global installations of `create-next-app` are no longer supported.
-
-### Add to existing project
-
-To Add Frontegg to your existing Nextjs project, follow below steps:
-
-1. Use package manager to install Frontegg Next.JS library.
-
-   ```bash
-     npm install --save @frontegg/nextjs
-   ```
-
-   or
-
-   ```bash
-     yarn add --save @frontegg/nextjs
-   ```
-
-2. Wrap the default export with `withFronteggApp` in `./pages/_app.tsx`:
-
-   ```tsx
-   // ./pages/_app.tsx
-
-   import { withFronteggApp } from '@frontegg/nextjs';
-
-   function CustomApp({ Component, pageProps }: AppProps) {
-     return <Component {...pageProps} />;
-   }
-
-   export default withFronteggApp(CustomApp);
-   ```
-
-3. Create files for frontegg middleware under `./pages/api/frontegg/[...frontegg-middleware].ts`:
-
-   ```tsx
-   // ./pages/api/frontegg/[...frontegg-middleware].ts
-
-   export { fronteggMiddleware as default } from '@frontegg/nextjs';
-   ```
-
-4. Create placeholder pages for frontegg router under `./pages/[...frontegg-router].tsx`:
-
-   ```tsx
-   // ./pages/[...frontegg-router].tsx
-
-   export {
-     FronteggRouter as default,
-     FronteggRouterProps as getServerSideProps,
-   } from '@frontegg/nextjs';
-   ```
-
-## Getting Started
-
-### Create Frontegg worksapce
-
-Navigate to [Frontegg Portal Settgins](https://portal.frontegg.com/development/settings), If you don't have application
-follow integration steps after signing up.
-
-Next, configure the "Allowed Origins" in your application under "Domain" tab of the "Settings" page :
-
-- http://localhost:3000 // for development environments
-- https://my-company-domain.com // for production environments
-
-Copy ClientID, Frontegg Domain from "Settings" page, You'll need these values in the next step.
-
-### Setup environment
-
-To setup your Next.js application to communicate with Frontegg, you have to create a new file named `.env.local` under
-your root project directory, this file will be used to store environment variables that will be used, configuration
-options:
-
-```dotenv
-# The AppUrl is to tell Frontegg your application hostname
-FRONTEGG_APP_URL='http://localhost:3000'
-
-# The Frontegg domain is your unique URL to connect to the Frontegg gateway
-FRONTEGG_BASE_URL='https://{YOUR_SUB_DOMAIN}.frontegg.com'
-
-# Your Frontegg application's Client ID
-FRONTEGG_CLIENT_ID='{YOUR_APPLICATION_CLIENT_ID}'
-
-# The statless session encruption password, used to encrypt
-# jwt before sending it to the client side.
-#
-# For quick password generation use the following command:
-#    node -e "console.log(crypto.randomBytes(32).toString('hex'))"
-FRONTEGG_ENCRYPTION_PASSWORD='{SESSION_ENCRYPTION_PASSWORD}'
-
-# The statless session cookie name
-FRONTEGG_COOKIE_NAME='fe_session'
-```
-
-## Documentation
-
-### API Reference
-
-Visit [Frontegg Docs](https://docs.frontegg.com) for the full documentation.
-
-### Frontegg Provider Options
-
-Pass seconds argument to `withFronteggApp` function in `_app.ts` file to customize
-Frontegg library.
-
-```tsx
-// ./pages/_app.tsx
-
-import { withFronteggApp } from '@frontegg/nextjs';
-
-function CustomApp({ Component, pageProps }: AppProps) {
-  return <Component {...pageProps} />;
-}
-
-export default withFronteggApp(CustomApp, {
-  /**
-   * Frontegg options for customizations
-   */
-});
-```
-
-### getSession
-
-For any pages that required AccessToken in Server Side, you can use:
-
-```tsx
-import { GetServerSideProps } from 'next';
-import { getSession } from '@frontegg/nextjs';
-
-export default function MyPage({ products }) {
-  return (
-    <div>
-      <h1>My Page</h1>
-      {products}
-    </div>
-  );
-}
-
-export const getServerSideProps: GetServerSideProps = async (context) => {
-  const session = await getSession(context.req);
-  if (session) {
-    const { data } = await fetch('{external}/product', {
-      headers: {
-        Authorization: 'bearer ' + session.accessToken,
-      },
-    });
-    return { props: { products: data } };
-  }
-
-  return { props: { products: [] } };
-};
-```
-
-### withSSRSession
-
-withSSRSession HOC can be used to automatic redirect users to login screen if not logged in:
-
-```tsx
-import { GetServerSideProps } from 'next';
-import { withSSRSession } from '@frontegg/nextjs';
-
-export default function MyPage({ products }) {
-  return (
-    <div>
-      <h1>My Page</h1>
-      {products}
-    </div>
-  );
-}
-
-export const getServerSideProps: GetServerSideProps = withSSRSession(
-  async (context, session) => {
-    const { data } = await fetch('{external}/product', {
-      headers: {
-        Authorization: 'bearer ' + session.accessToken,
-      },
-    });
-    return { props: { products: data } };
-  }
-);
-```
-
-## Next.js middlewares usage
-
-To prevent access unauthenticated user to all routes, use [Next.js middlewares](https://nextjs.org/docs/advanced-features/middleware).
-
-**Note: If you were using Middleware prior to 12.2, please see the [upgrade guide](https://nextjs.org/docs/messages/middleware-upgrade-guide).**
-
-```ts
-// /middleware.ts
-import { NextResponse } from "next/server";
-import type { NextRequest } from "next/server";
-import { getSession } from '@frontegg/nextjs';
-
-export const middleware = async (request: NextRequest) => {
-  const session = await getSession(request);
-
-  console.log("middleware session", session);
-  
-  if(!session){
-    // redirect unauthenticated user to /account/login page
-    return NextResponse.redirect(new URL('/account/login', req.url))
-  }
-  
-  return NextResponse.next();
-};
-
-export const config = {
-  matcher: "/(.*)",
-};
-```
+Run `nx test nextjs` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@frontegg/nextjs",
-  "version": "6.5.0-alpha.3076979339",
+  "version": "6.5.0",
   "dependencies": {
-    "@frontegg/js": "6.9.0",
-    "@frontegg/react-hooks": "6.9.0",
+    "@frontegg/js": "6.10.0",
+    "@frontegg/react-hooks": "6.10.0",
     "jose": "^4.8.0",
     "iron-session": "^6.2.1",
     "http-proxy": "^1.18.1",
@@ -16,4 +16,4 @@
   "main": "./index.cjs.js",
   "module": "./index.esm.js",
   "typings": "./index.d.ts"
-}
+}