@frontegg/nextjs 5.4.1 → 5.6.0-alpha.2648925786

package/README.md

@@ -1,7 +1,217 @@
-# nextjs
+![alt text](./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)
+- [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)
+  - 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/tree/main" --example-path "apps/example" my-nextjs-app-name
+```
+
+or
+
+```bash
+  yarn create next-app --example "https://github.com/frontegg/frontegg-nextjs/tree/main" --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 } };
+  }
+);
+```

package/index.cjs.js

@@ -1258,12 +1258,14 @@ function FronteggRouter() {
   return '';
 }
 function FronteggRouterProps(context) {
+  var _a;
+
   var routesObj = Object.assign(Object.assign({}, reduxStore.authInitialState.routes), fronteggConfig.authRoutes);
   var routesArr = Object.keys(routesObj).reduce(function (p, key) {
     return [].concat(_toConsumableArray(p), [routesObj[key]]);
   }, []);
 
-  var _parse = url.parse(context.req.url, true),
+  var _parse = url.parse((_a = context.resolvedUrl) !== null && _a !== void 0 ? _a : context.req.url, true),
       pathname = _parse.pathname;
 
   if (!pathname || pathname.startsWith('/_next/data')) {
@@ -1421,7 +1423,7 @@ function withSSRSession(handler) {
 
   return function (context) {
     return __awaiter(_this, void 0, void 0, /*#__PURE__*/regenerator.mark(function _callee2() {
-      var _a, session;
+      var _a, _b, session, loginUrl;
 
       return regenerator.wrap(function _callee2$(_context2) {
         while (1) {
@@ -1441,15 +1443,21 @@ function withSSRSession(handler) {
               return _context2.abrupt("return", handler(context, session));
 
             case 7:
+              loginUrl = (_a = fronteggConfig.authRoutes.loginUrl) !== null && _a !== void 0 ? _a : reduxStore.authInitialState.routes.loginUrl;
+
+              if (!loginUrl.startsWith('/')) {
+                loginUrl = "/".concat(loginUrl);
+              }
+
               return _context2.abrupt("return", {
                 redirect: {
                   permanent: false,
-                  destination: "/".concat((_a = fronteggConfig.authRoutes.loginUrl) !== null && _a !== void 0 ? _a : reduxStore.authInitialState.routes.loginUrl, "?redirectUrl=").concat(encodeURIComponent(context.req.url))
+                  destination: "".concat(loginUrl, "?redirectUrl=").concat(encodeURIComponent((_b = context.resolvedUrl) !== null && _b !== void 0 ? _b : context.req.url))
                 },
                 props: {}
               });
 
-            case 8:
+            case 10:
             case "end":
               return _context2.stop();
           }

package/index.esm.js

@@ -1232,12 +1232,14 @@ function FronteggRouter() {
   return '';
 }
 function FronteggRouterProps(context) {
+  var _a;
+
   var routesObj = Object.assign(Object.assign({}, authInitialState.routes), fronteggConfig.authRoutes);
   var routesArr = Object.keys(routesObj).reduce(function (p, key) {
     return [].concat(_toConsumableArray(p), [routesObj[key]]);
   }, []);
 
-  var _parse = parse(context.req.url, true),
+  var _parse = parse((_a = context.resolvedUrl) !== null && _a !== void 0 ? _a : context.req.url, true),
       pathname = _parse.pathname;
 
   if (!pathname || pathname.startsWith('/_next/data')) {
@@ -1395,7 +1397,7 @@ function withSSRSession(handler) {
 
   return function (context) {
     return __awaiter(_this, void 0, void 0, /*#__PURE__*/regenerator.mark(function _callee2() {
-      var _a, session;
+      var _a, _b, session, loginUrl;
 
       return regenerator.wrap(function _callee2$(_context2) {
         while (1) {
@@ -1415,15 +1417,21 @@ function withSSRSession(handler) {
               return _context2.abrupt("return", handler(context, session));
 
             case 7:
+              loginUrl = (_a = fronteggConfig.authRoutes.loginUrl) !== null && _a !== void 0 ? _a : authInitialState.routes.loginUrl;
+
+              if (!loginUrl.startsWith('/')) {
+                loginUrl = "/".concat(loginUrl);
+              }
+
               return _context2.abrupt("return", {
                 redirect: {
                   permanent: false,
-                  destination: "/".concat((_a = fronteggConfig.authRoutes.loginUrl) !== null && _a !== void 0 ? _a : authInitialState.routes.loginUrl, "?redirectUrl=").concat(encodeURIComponent(context.req.url))
+                  destination: "".concat(loginUrl, "?redirectUrl=").concat(encodeURIComponent((_b = context.resolvedUrl) !== null && _b !== void 0 ? _b : context.req.url))
                 },
                 props: {}
               });
 
-            case 8:
+            case 10:
             case "end":
               return _context2.stop();
           }

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@frontegg/nextjs",
-  "version": "5.4.1",
+  "version": "5.6.0-alpha.2648925786",
   "dependencies": {
-    "@frontegg/admin-portal": "5.54.2",
-    "@frontegg/react-hooks": "5.54.2",
+    "@frontegg/admin-portal": "5.66.0",
+    "@frontegg/react-hooks": "5.66.0",
     "jose": "^4.8.0",
     "iron-session": "^6.1.2",
     "http-proxy": "^1.18.1",
@@ -16,4 +16,4 @@
   "main": "./index.cjs.js",
   "module": "./index.esm.js",
   "typings": "./index.d.ts"
-}
+}

package/withFronteggApp.d.ts

@@ -1,8 +1,10 @@
-import type { AppInitialProps, AppType } from 'next/dist/shared/lib/utils';
-import { AppContextType, AppPropsType, NextComponentType } from 'next/dist/shared/lib/utils';
+import type { AppProps, AppInitialProps } from 'next/app';
+import type { AppType, AppContextType, AppPropsType, NextComponentType } from 'next/dist/shared/lib/utils';
 import { FronteggNextJSSession } from './types';
 import { FronteggAppOptions } from '@frontegg/types';
-export declare const withFronteggApp: (app: AppType, options?: (Omit<FronteggAppOptions, "contextOptions"> & {
+export declare const withFronteggApp: (app: ((props: AppProps) => JSX.Element) & {
+    getInitialProps?: AppType['getInitialProps'];
+}, options?: (Omit<FronteggAppOptions, "contextOptions"> & {
     contextOptions?: import("@frontegg/types/ContextOptions").ContextOptions | undefined;
 }) | undefined) => NextComponentType<AppContextType & {
     session: FronteggNextJSSession | null;