@frontegg/nextjs 6.7.5-alpha.3532620063 → 6.7.5

package/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Change Log
+
+## [6.7.5](https://github.com/frontegg/frontegg-nextjs/compare/v6.7.4...v6.7.5) (2022-11-28)
+
+# v6.7.5
+- Update hide fields API according to new security tabs naming
+- Changed max length for secret fields to 100 characters
+- Added support for customizing invite user dialog fields
+- Added support for admin portal pre-defined theme options (dark, vivid, modern, and classic themes)
+- Added support for customizing admin portal navigation hover color
+- Fixed typo of Andorra country in countries dropdown
+- Fixed select popup alignment issue
+- Changed no local authentication feature to also hide the sign-up form when there is no local authentication option (use only social logins and SSO for signing up)
+- Added mock for feature flags API for admin portal preview mode
+- Fixed resend invitation and activate your account API calls
+- Fixed creating custom webhook on the Admin Portal is sent with the event ID and not with the event Key
+- Added support for customizing fields and tabs in the admin portal
+
+### NextJS Wrapper 6.7.5:
+- Updated next readme to include hosted login box integration
+
+## [6.7.4](https://github.com/frontegg/frontegg-nextjs/compare/v6.7.3...v6.7.4) (2022-11-15)
+
+- Fixed redirect to the app after signing up without forced email verification
+- Fixed admin portal dark theme
+- Added the ability to customize fields and tabs in the admin portal
+- Fixed cleaning up error messages on sign up page when re-visiting the page
+- Fixed resizing the login box when the logo is null
+- Fix the ReCaptcha timeout issue
+
+## [6.7.3](https://github.com/frontegg/frontegg-nextjs/compare/v6.7.2...v6.7.3) (2022-11-11)
+
+- FR-9186 - support ssr with session and refresh token
+- FR-9614 - Add support for innerThemeProvider for admin portal pages and tabs
+
+- FR-9186 - fix pipeline
+### AdminPortal 6.36.0:
+- 
+
+### AdminPortal 6.35.0:
+- 
+### AdminPortal 6.34.0:
+- 
+
+### NextJS Wrapper 6.7.3:
+- FR-9544 - remove console logs
+- FR-9544 - Add support for keep session a live
+- FR-9187 - split cookie if exceeds length of 4096
+
+## [6.7.2](https://github.com/frontegg/frontegg-nextjs/compare/v6.7.1...v6.7.2) (2022-10-26)
+
+### AdminPortal 6.34.0:
+- 
+
+### NextJS Wrapper 6.7.2:
+- FR-9186 - Fix Changelog
+- FR-9186 - Generate changelog for pre-release / releases based on AdminPortal and LoginBox changes
+

package/README.md

@@ -1,7 +1,259 @@
-# nextjs
+![alt text](https://github.com/frontegg/frontegg-nextjs/blob/master/logo.png)
 
-This library was generated with [Nx](https://nx.dev).
+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.
 
-## Running unit tests
+## Table of Contents
 
-Run `nx test nextjs` to execute the unit tests via [Jest](https://jestjs.io).
+- [Installation](#installation)
+  - [Create new NextJS project](#create-new-nextjs-project)
+  - [Add to existing project](#add-to-existing-project)
+  - [Using Vercel platform with custom domain](#using-vercel-platform-with-custom-domain)
+- [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, {
+    hostedLoginBox: true
+  });
+   ```
+
+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';
+   ```
+
+### Using Vercel platform with custom domain
+
+  1. Visit `https://vercel.com/[ACCOUNT_ID]/[PROJECT_ID]/settings/environment-variables`
+  2. Add `FRONTEGG_APP_URL` environment variable for each Vercel Environment
+  ![vercel-settings-pages](https://github.com/frontegg/frontegg-nextjs/blob/master/vercel-environment.png)
+ 
+
+## 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, {
+  hostedLoginBox: true,
+  /**
+   * 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: "/(.*)",
+};
+```

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@frontegg/nextjs",
-  "version": "6.7.5-alpha.3532620063",
+  "version": "6.7.5",
   "dependencies": {
-    "@frontegg/js": "6.45.0-alpha.10",
-    "@frontegg/react-hooks": "6.45.0-alpha.10",
+    "@frontegg/js": "6.46.0",
+    "@frontegg/react-hooks": "6.46.0",
     "jose": "^4.9.2",
     "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"
-}
+}