@multiplatform.one/keycloak 0.3.1 → 0.3.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiplatform.one/keycloak",
-  "version": "0.3.1",
+  "version": "0.3.4",
   "description": "keycloak client for multiplatform.one ecosystem",
   "main": "dist/lib",
   "module": "dist/esm",

package/src/hooks/index.ts

@@ -4,7 +4,7 @@
  * File Created: 08-11-2022 06:34:56
  * Author: Clay Risser
  * -----
- * Last Modified: 25-11-2022 09:52:31
+ * Last Modified: 15-05-2023 01:58:05
  * Modified By: Clay Risser
  * -----
  * Risser Labs LLC (c) Copyright 2021 - 2022
@@ -23,5 +23,6 @@
  */
 
 export * from './useCurrentRouteName';
+export * from './useIsPassedInToken';
 export * from './useKeycloak';
 export * from './useLogin';

package/src/hooks/useIsPassedInToken/index.native.ts

@@ -0,0 +1,25 @@
+/**
+ * File: /src/hooks/useIsPassedInToken/index.native.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 15-05-2023 01:54:48
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 15-05-2023 01:55:27
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2022 - 2023
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export const useIsPassedInToken = () => false;

package/src/hooks/useIsPassedInToken/index.ts

@@ -0,0 +1,31 @@
+/**
+ * File: /src/hooks/useIsPassedInToken/index.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 15-05-2023 01:54:44
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 15-05-2023 01:56:30
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2022 - 2023
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { MultiPlatform } from 'multiplatform.one';
+import { useRouter } from 'next/router';
+
+export function useIsPassedInToken() {
+  const { query } = MultiPlatform.isNext ? useRouter() : { query: {} };
+  return 'idToken' in query || 'token' in query || 'refreshToken' in query;
+}

package/src/provider/index.tsx

@@ -29,6 +29,7 @@ import type { FC, ComponentType, ReactNode } from 'react';
 import type { KeycloakConfig, KeycloakInitOptions } from '@bitspur/keycloak-js';
 import { AuthConfigContext, defaultAuthConfig } from '../authConfig';
 import { KeycloakProvider } from './keycloakProvider';
+import { useIsPassedInToken } from '../hooks';
 // @ts-ignore
 import { config } from 'app/config';
 
@@ -67,6 +68,7 @@ export const AuthProvider: FC<AuthProviderProps> = ({
   onTokens,
   ...keycloakInitOptions
 }: AuthProviderProps) => {
+  const isPassedInToken = useIsPassedInToken();
   const authConfig = useMemo(
     () => ({
       ...defaultAuthConfig,
@@ -74,7 +76,7 @@ export const AuthProvider: FC<AuthProviderProps> = ({
       ensureFreshness,
       loginRoute,
       messageHandlerKeys,
-      persist,
+      persist: ssr || isPassedInToken ? false : persist,
       ssr,
     }),
     [debug, ensureFreshness, loginRoute, messageHandlerKeys, persist, ssr],

package/src/provider/keycloakProvider.tsx

@@ -33,6 +33,7 @@ import { ReactKeycloakProvider } from '@bitspur/react-keycloak-web';
 import { SSRKeycloakProvider, SSRCookies } from '@bitspur/react-keycloak-ssr';
 import { useAuthConfig } from '../hooks/useAuthConfig';
 import { useAuthState } from '../state';
+import { useIsPassedInToken } from '../hooks';
 import { useRouter } from 'next/router';
 
 export interface KeycloakProviderProps {
@@ -60,18 +61,27 @@ export function KeycloakProvider({
   const authState = useAuthState();
   const LoadingComponent = loadingComponent || (() => <>{debug ? 'authenticating' : null}</>);
   const { query } = MultiPlatform.isNext ? useRouter() : { query: {} };
+  const [refreshToken, setRefreshToken] = useState<string | boolean>(
+    validToken(
+      (ensureFreshness &&
+        (('refreshToken' in query && (query.refreshToken?.toString() || true)) ||
+          (persist && authState.refreshToken))) ||
+        false,
+    ),
+  );
   const [idToken, setIdToken] = useState<string | boolean>(
-    ('idToken' in query && (query.idToken?.toString() || true)) || (persist && authState.idToken) || false,
+    validToken(
+      ('idToken' in query && (query.idToken?.toString() || true)) || (persist && authState.idToken) || false,
+      refreshToken,
+    ),
   );
   const [token, setToken] = useState<string | boolean>(
-    ('token' in query && (query.token?.toString() || true)) || (persist && authState.token) || false,
+    validToken(
+      ('token' in query && (query.token?.toString() || true)) || (persist && authState.token) || false,
+      refreshToken,
+    ),
   );
-  const [refreshToken, setRefreshToken] = useState<string | boolean>(
-    (ensureFreshness &&
-      (('refreshToken' in query && (query.refreshToken?.toString() || true)) || (persist && authState.refreshToken))) ||
-      false,
-  );
-  const explicitToken = 'idToken' in query || 'token' in query || 'refreshToken' in query;
+  const isPassedInToken = useIsPassedInToken();
 
   useEffect(() => {
     if (token !== true && refreshToken !== true && idToken !== true) return;
@@ -84,15 +94,9 @@ export function KeycloakProvider({
   }, []);
 
   useEffect(() => {
-    if (typeof idToken === 'string' && !isTokenValid(idToken)) setIdToken(false);
-    if (typeof refreshToken === 'string' && !isTokenValid(refreshToken)) setRefreshToken(false);
-    if (typeof token === 'string' && !isTokenValid(token)) setToken(false);
-  }, [idToken, token, refreshToken]);
-
-  useEffect(() => {
-    if (token !== true) return;
+    if (refreshToken !== true) return;
     const messageCallback = (e: MessageEvent<any>) => {
-      let data = e?.data;
+      let data = e?.data || null;
       if (typeof data === 'string') {
         try {
           data = JSON.parse(data);
@@ -101,15 +105,15 @@ export function KeycloakProvider({
       if (debug) logger.debug('received message', data);
       const message: MessageSchema = data;
       if (!message.type) return;
-      if (message.type.toUpperCase() === 'TOKEN' && message.payload) {
-        if (debug) logger.debug('setting token', message.payload);
-        setToken(message.payload);
+      if (message.type.toUpperCase() === 'REFRESH_TOKEN' && message.payload) {
+        if (debug) logger.debug('setting refresh token', message.payload);
+        setRefreshToken(validToken(message.payload));
       }
     };
     if (debug) {
       logger.debug('listening for message', {
-        type: 'TOKEN',
-        payload: '<some_token>',
+        type: 'REFRESH_TOKEN',
+        payload: '<some_refresh_token>',
       });
     }
     window.addEventListener('message', messageCallback);
@@ -119,9 +123,9 @@ export function KeycloakProvider({
   }, []);
 
   useEffect(() => {
-    if (idToken !== true) return;
+    if (token !== true) return;
     const messageCallback = (e: MessageEvent<any>) => {
-      let data = e?.data;
+      let data = e?.data || null;
       if (typeof data === 'string') {
         try {
           data = JSON.parse(data);
@@ -130,15 +134,15 @@ export function KeycloakProvider({
       if (debug) logger.debug('received message', data);
       const message: MessageSchema = data;
       if (!message.type) return;
-      if (message.type.toUpperCase() === 'ID_TOKEN' && message.payload) {
-        if (debug) logger.debug('setting id token', message.payload);
-        setIdToken(message.payload);
+      if (message.type.toUpperCase() === 'TOKEN' && message.payload) {
+        if (debug) logger.debug('setting token', message.payload);
+        setToken(validToken(message.payload, refreshToken));
       }
     };
     if (debug) {
       logger.debug('listening for message', {
-        type: 'ID_TOKEN',
-        payload: '<some_id_token>',
+        type: 'TOKEN',
+        payload: '<some_token>',
       });
     }
     window.addEventListener('message', messageCallback);
@@ -148,9 +152,9 @@ export function KeycloakProvider({
   }, []);
 
   useEffect(() => {
-    if (refreshToken !== true) return;
+    if (idToken !== true) return;
     const messageCallback = (e: MessageEvent<any>) => {
-      let data = e?.data;
+      let data = e?.data || null;
       if (typeof data === 'string') {
         try {
           data = JSON.parse(data);
@@ -159,15 +163,15 @@ export function KeycloakProvider({
       if (debug) logger.debug('received message', data);
       const message: MessageSchema = data;
       if (!message.type) return;
-      if (message.type.toUpperCase() === 'REFRESH_TOKEN' && message.payload) {
-        if (debug) logger.debug('setting refresh token', message.payload);
-        setRefreshToken(message.payload);
+      if (message.type.toUpperCase() === 'ID_TOKEN' && message.payload) {
+        if (debug) logger.debug('setting id token', message.payload);
+        setIdToken(validToken(message.payload, refreshToken));
       }
     };
     if (debug) {
       logger.debug('listening for message', {
-        type: 'REFRESH_TOKEN',
-        payload: '<some_refresh_token>',
+        type: 'ID_TOKEN',
+        payload: '<some_id_token>',
       });
     }
     window.addEventListener('message', messageCallback);
@@ -207,7 +211,7 @@ export function KeycloakProvider({
       initOptions.token = token;
       if (idToken && typeof idToken === 'string') initOptions.idToken = idToken;
       if (refreshToken && typeof refreshToken === 'string') initOptions.refreshToken = refreshToken;
-      if (explicitToken) {
+      if (isPassedInToken) {
         initOptions.checkLoginIframe = false;
         initOptions.onLoad = undefined;
       }
@@ -253,7 +257,16 @@ export function KeycloakProvider({
   );
 }
 
-export function isTokenValid(token: string) {
+function validToken(token: string | boolean, refreshToken?: string | boolean) {
+  if (typeof token !== 'string') return token;
+  if (refreshToken) {
+    if (refreshToken === true || isTokenValid(refreshToken)) return token;
+    return false;
+  }
+  return isTokenValid(token) ? token : false;
+}
+
+function isTokenValid(token: string) {
   try {
     const { exp } = JSON.parse(Buffer.from(token.split('.')?.[1] || '', 'base64').toString() || '{}');
     return Math.floor(Date.now() / 1000) <= exp;