@multiplatform.one/keycloak 0.7.14 → 0.7.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiplatform.one/keycloak",
-  "version": "0.7.14",
+  "version": "0.7.16",
   "description": "keycloak client for multiplatform.one ecosystem",
   "main": "lib/index.js",
   "module": "lib/index.mjs",
@@ -12,6 +12,11 @@
       "import": "./lib/index.mjs",
       "require": "./lib/index.js",
       "types": "./lib/index.d.ts"
+    },
+    "./routes": {
+      "import": "./lib/routes.mjs",
+      "require": "./lib/routes.js",
+      "types": "./lib/routes.d.ts"
     }
   },
   "author": "BitSpur",
@@ -26,9 +31,8 @@
   "homepage": "https://multiplatform.one",
   "license": "Apache-2.0",
   "files": [
-    "dist",
-    "index.d.ts",
     "lib",
+    "routes",
     "src"
   ],
   "repository": {
@@ -36,34 +40,35 @@
     "url": "https://gitlab.com/risserlabs/multiplatform.one/keycloak"
   },
   "peerDependencies": {
-    "@react-native-async-storage/async-storage": "^1.17.11",
-    "@react-navigation/native": "^6.0.14",
+    "@react-native-async-storage/async-storage": "1.19.3",
     "expo-keycloak-auth": "1.0.14",
-    "multiplatform.one": "^0.7.15",
+    "multiplatform.one": "^0.7.16",
     "next": "^13.0.5",
     "react": "^18.2.0",
-    "react-native": "~0.68.5"
+    "react-native": "~0.73.1"
   },
   "devDependencies": {
-    "@react-native-async-storage/async-storage": "^1.19.3",
+    "@react-native-async-storage/async-storage": "1.21.0",
     "@react-navigation/native": "^6.1.9",
-    "@types/eslint": "^8",
-    "@types/jest": "^29.5.6",
-    "@types/lodash.camelcase": "^4.3.8",
-    "@types/lodash.startcase": "^4.4.8",
-    "@types/react": "^18.2.32",
-    "@types/react-native": "^0.72.5",
-    "cspell": "^7.3.8",
+    "@types/eslint": "^8.56.2",
+    "@types/jest": "^29.5.11",
+    "@types/lodash.camelcase": "^4.3.9",
+    "@types/lodash.startcase": "^4.4.9",
+    "@types/react": "^18.2.47",
+    "@types/react-native": "^0.73.0",
+    "cspell": "^8.3.2",
+    "eslint": "^8.56.0",
     "expo-keycloak-auth": "1.0.14",
     "jest": "^29.7.0",
     "jest-sonar-reporter": "^2.0.0",
-    "multiplatform.one": "^0.7.15",
+    "multiplatform.one": "^0.7.16",
     "next": "^13.5.6",
-    "prettier": "^3.0.3",
+    "prettier": "^3.1.1",
     "react": "^18.2.0",
-    "react-native": "~0.72.6",
-    "ts-node": "^10.9.1",
-    "typescript": "~5.2.2"
+    "react-native": "~0.73.2",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3"
   },
   "engines": {
     "node": ">=6.0.0"
@@ -90,13 +95,8 @@
     "indent": 4
   },
   "dependencies": {
-    "@bitspur/keycloak-js": "^21.1.2",
-    "@bitspur/react-keycloak-ssr": "^4.0.14",
-    "@bitspur/react-keycloak-web": "^4.0.14",
-    "core-js-pure": "^3.33.1",
-    "eslint": "^8.55.0",
-    "expo-auth-session": "^5.2.2",
-    "solito": "^4.1.3",
-    "tsup": "^8.0.1"
+    "expo-auth-session": "^5.4.0",
+    "keycloak-js": "^23.0.4",
+    "next-auth": "^4.24.5"
   }
 }

package/routes/index.d.ts

@@ -0,0 +1,22 @@
+/*
+ *  File: /routes/index.d.ts
+ *  Project: multiplatform.one
+ *  File Created: 22-06-2023 05:33:21
+ *  Author: Clay Risser
+ *  -----
+ *  BitSpur (c) Copyright 2021 - 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 * from '../lib/routes.js';

package/routes/index.js

@@ -0,0 +1,22 @@
+/*
+ *  File: /routes/index.js
+ *  Project: multiplatform.one
+ *  File Created: 22-06-2023 05:33:21
+ *  Author: Clay Risser
+ *  -----
+ *  BitSpur (c) Copyright 2021 - 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.
+ */
+
+module.exports = require('../lib/routes/index');

package/src/Authenticated.tsx

@@ -21,38 +21,48 @@
 
 import React, { useEffect } from 'react';
 import type { ComponentType, ReactNode } from 'react';
-import { useLogin, useKeycloak } from './hooks';
-import { useAuthState } from './state';
+import { MultiPlatform } from 'multiplatform.one';
 import { useAuthConfig, useTokensFromQuery, useTokensFromState } from './hooks';
+import { useKeycloak } from './keycloak';
 
 export interface AuthenticatedProps {
   children: ReactNode;
   disabled?: boolean;
+  loadingComponent?: ComponentType;
   loggedOutComponent?: ComponentType;
-  loginRoute?: string;
 }
 
-export function Authenticated({ children, disabled, loginRoute, loggedOutComponent }: AuthenticatedProps) {
+export function Authenticated({ children, disabled, loggedOutComponent, loadingComponent }: AuthenticatedProps) {
   const authConfig = useAuthConfig();
-  const authState = useAuthState();
-  const login = useLogin(loginRoute);
+  const keycloak = useKeycloak();
   const tokensFromQuery = useTokensFromQuery();
   const tokensFromState = useTokensFromState();
-  const { authenticated } = useKeycloak();
 
   useEffect(() => {
-    if (authenticated !== false) return;
-    if (authConfig.persist) {
-      authState.setIdToken('');
-      authState.setRefreshToken('');
-      authState.setToken('');
+    if (
+      !keycloak ||
+      MultiPlatform.isIframe ||
+      MultiPlatform.isServer ||
+      keycloak.authenticated ||
+      tokensFromQuery ||
+      tokensFromState
+    ) {
+      return;
     }
-    if (typeof window !== 'undefined' && !tokensFromQuery && !tokensFromState && window.self === window.top) login();
-  }, [authenticated]);
+    keycloak.login({
+      redirectUri: authConfig.loginRedirectUri,
+    });
+  }, [keycloak]);
 
-  if (disabled || authenticated) return <>{children}</>;
-  const LoggedOutComponent = loggedOutComponent || (() => <>{authConfig.debug ? 'not authenticated' : null}</>);
-  return <LoggedOutComponent />;
+  if (typeof disabled === 'undefined') disabled = authConfig.disabled;
+  if (disabled) return <>{children}</>;
+  if (typeof keycloak === 'undefined') {
+    const LoadingComponent = loadingComponent;
+    return LoadingComponent ? <LoadingComponent /> : <>{authConfig.debug ? 'loading' : null}</>;
+  }
+  if (keycloak.authenticated) return <>{children}</>;
+  const LoggedOutComponent = loggedOutComponent;
+  return LoggedOutComponent ? <LoggedOutComponent /> : <>{authConfig.debug ? 'not authenticated' : null}</>;
 }
 
 export function withAuthenticated<P extends object>(Component: ComponentType<P>) {

package/src/authConfig.ts

@@ -21,19 +21,13 @@
 
 import { createContext } from 'react';
 
-export const defaultAuthConfig: AuthConfig = {
-  ensureFreshness: true,
-  persist: false,
-  ssr: false,
-};
+export const defaultAuthConfig: AuthConfig = {};
 
 export const AuthConfigContext = createContext<AuthConfig>(defaultAuthConfig);
 
 export interface AuthConfig {
   debug?: boolean;
-  ensureFreshness?: boolean;
-  loginRoute?: string;
+  disabled?: boolean;
+  loginRedirectUri?: string;
   messageHandlerKeys?: string[];
-  persist?: boolean;
-  ssr?: boolean;
 }

package/src/hooks/index.ts

@@ -20,8 +20,5 @@
  */
 
 export * from './useAuthConfig';
-export * from './useCurrentRouteName';
-export * from './useKeycloak';
-export * from './useLogin';
 export * from './useTokensFromQuery';
 export * from './useTokensFromState';

package/src/hooks/useTokensFromQuery/index.ts

@@ -23,6 +23,7 @@ import { MultiPlatform } from 'multiplatform.one';
 import { useRouter } from 'next/router';
 
 export function useTokensFromQuery() {
+  if (!MultiPlatform.isIframe) return false;
   const { query } = MultiPlatform.isNext ? useRouter() : { query: {} };
   return 'idToken' in query || 'token' in query || 'refreshToken' in query;
 }

package/src/hooks/useTokensFromState.ts

@@ -20,7 +20,7 @@
  */
 
 import { useAuthState } from '../state';
-import { validToken } from '../util';
+import { validToken } from '../token';
 
 export function useTokensFromState() {
   const authState = useAuthState();

package/src/index.ts

@@ -22,4 +22,7 @@
 export * from './Authenticated';
 export * from './authConfig';
 export * from './hooks';
+export * from './keycloak';
 export * from './provider';
+export * from './session';
+export * from './types';

package/src/{@types/coreJsPure.d.ts → keycloak/context.ts}

@@ -1,10 +1,10 @@
 /*
- *  File: /src/@types/coreJsPure.d.ts
+ *  File: /src/keycloak/context.ts
  *  Project: @multiplatform.one/keycloak
- *  File Created: 23-06-2023 09:00:47
+ *  File Created: 10-01-2024 15:10:13
  *  Author: Clay Risser
  *  -----
- *  BitSpur (c) Copyright 2021 - 2023
+ *  BitSpur (c) Copyright 2021 - 2024
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -19,12 +19,7 @@
  *  limitations under the License.
  */
 
-// declare module 'core-js-pure/stable/atob' {
-//   const atob: (...args: any[]) => any;
-//   export = atob;
-// }
+import type { Keycloak } from './keycloak';
+import { createContext } from 'react';
 
-// declare module 'core-js-pure/stable/escape' {
-//   const escape: (...args: any[]) => any;
-//   export = escape;
-// }
+export const KeycloakContext = createContext<Keycloak | undefined>(undefined);

package/{lib/@types/expoKeycloakAuth.d.d.mts → src/keycloak/index.ts}

@@ -1,10 +1,10 @@
 /*
- *  File: /src/@types/expoKeycloakAuth.d.ts
+ *  File: /src/keycloak/index.ts
  *  Project: @multiplatform.one/keycloak
- *  File Created: 22-06-2023 10:07:56
+ *  File Created: 09-01-2024 11:59:25
  *  Author: Clay Risser
  *  -----
- *  BitSpur (c) Copyright 2021 - 2023
+ *  BitSpur (c) Copyright 2021 - 2024
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -19,7 +19,4 @@
  *  limitations under the License.
  */
 
-declare module 'expo-keycloak-auth' {
-  export function useKeycloak(): any;
-  export const KeycloakProvider: any;
-}
+export * from './keycloak';

package/src/keycloak/keycloak.native.ts

@@ -0,0 +1,148 @@
+/*
+ *  File: /src/keycloak/keycloak.native.ts
+ *  Project: @multiplatform.one/keycloak
+ *  File Created: 09-01-2024 11:59:37
+ *  Author: Clay Risser
+ *  -----
+ *  BitSpur (c) Copyright 2021 - 2024
+ *
+ *  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 type KeycloakClient from 'keycloak-js';
+import type { AccessTokenParsed, TokenParsed } from '../token';
+import type { KeycloakLoginOptions, KeycloakLogoutOptions } from 'keycloak-js';
+import type { KeycloakMock } from '../types';
+import { MultiPlatform } from 'multiplatform.one';
+import { getSession } from '../session/session';
+import { jwtDecode } from 'jwt-decode';
+import { useKeycloak as useExpoKeycloak } from 'expo-keycloak-auth';
+
+export class Keycloak {
+  token: string;
+  idToken?: string;
+  refreshToken?: string;
+
+  private _tokenParsed?: AccessTokenParsed;
+  private _idTokenParsed?: TokenParsed;
+  private _refreshTokenParsed?: TokenParsed;
+  private keycloakClient?: KeycloakClient;
+  private mock: KeycloakMock | undefined;
+
+  constructor(input: string | KeycloakClient | KeycloakMock, idToken?: string, refreshToken?: string) {
+    if (typeof input === 'string') {
+      this.token = input;
+      this.idToken = idToken;
+      this.refreshToken = refreshToken;
+    } else if (typeof input === 'object') {
+      if (typeof (input as KeycloakClient).init === 'function') {
+        this.keycloakClient = input as KeycloakClient;
+      } else {
+        this.mock = input as KeycloakMock;
+      }
+    }
+    if (this.token && !this._tokenParsed) this._tokenParsed = jwtDecode(this.token) as AccessTokenParsed;
+    if (this.idToken && !this._idTokenParsed) this._idTokenParsed = jwtDecode(this.idToken) as TokenParsed;
+    if (this.refreshToken && !this._refreshTokenParsed) {
+      this._refreshTokenParsed = jwtDecode(this.refreshToken) as TokenParsed;
+    }
+  }
+
+  get tokenParsed() {
+    if (this.keycloakClient) return this.keycloakClient.tokenParsed as AccessTokenParsed;
+    return this._tokenParsed;
+  }
+
+  get idTokenParsed() {
+    if (this.keycloakClient) return this.keycloakClient.idTokenParsed as TokenParsed;
+    return this._idTokenParsed;
+  }
+
+  get refreshTokenParsed() {
+    if (this.keycloakClient) return this.keycloakClient.refreshTokenParsed as TokenParsed;
+    return this._refreshTokenParsed;
+  }
+
+  get clientId() {
+    if (this.keycloakClient) return this.keycloakClient.clientId;
+    return this.tokenParsed?.azp;
+  }
+
+  get email() {
+    if (this.keycloakClient) return this.keycloakClient.tokenParsed?.email;
+    if (this.mock) return this.mock.email;
+    return this.tokenParsed?.email;
+  }
+
+  get realm() {
+    if (this.keycloakClient) return this.keycloakClient.realm;
+    return this.tokenParsed?.iss?.split('/').pop();
+  }
+
+  get realmAccess() {
+    if (this.keycloakClient) return this.keycloakClient.realmAccess;
+    return this.tokenParsed?.realm_access;
+  }
+
+  get resourceAccess() {
+    if (this.keycloakClient) return this.keycloakClient.resourceAccess;
+    return this.tokenParsed?.resource_access;
+  }
+
+  get sessionId() {
+    if (this.keycloakClient) return this.keycloakClient.sessionId;
+    return this.tokenParsed?.session_state;
+  }
+
+  get subject() {
+    if (this.keycloakClient) return this.keycloakClient.subject;
+    return this.tokenParsed?.sub;
+  }
+
+  get username() {
+    if (this.mock) return this.mock.username;
+    return this.tokenParsed?.preferred_username;
+  }
+
+  async login(options: KeycloakLoginOptions = {}) {
+    if (this.keycloakClient) {
+      await this.keycloakClient.login(options);
+    }
+  }
+
+  async logout(options: KeycloakLogoutOptions = {}) {
+    if (this.keycloakClient) {
+      await this.keycloakClient.logout(options);
+    }
+  }
+
+  async isAuthenticated() {
+    if (this.mock) return true;
+    if (this.keycloakClient) return !!this.keycloakClient.authenticated;
+    if (MultiPlatform.isNext) return !!(await getSession());
+    if (!this.tokenParsed?.exp) return false;
+    return this.tokenParsed.exp > Date.now() / 1000;
+  }
+}
+
+export function useKeycloak() {
+  const { token, refreshToken, idToken } = useExpoKeycloak();
+  if (MultiPlatform.isServer) return;
+  if (MultiPlatform.isStorybook) {
+    return new Keycloak({
+      email: 'storybook@example.com',
+      username: 'storybook',
+    });
+  }
+  if (token) return new Keycloak(token, idToken, refreshToken);
+}

package/src/keycloak/keycloak.ts

@@ -0,0 +1,175 @@
+/*
+ *  File: /src/keycloak/keycloak.ts
+ *  Project: @multiplatform.one/keycloak
+ *  File Created: 09-01-2024 11:59:37
+ *  Author: Clay Risser
+ *  -----
+ *  BitSpur (c) Copyright 2021 - 2024
+ *
+ *  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 type KeycloakClient from 'keycloak-js';
+import type { AccessTokenParsed, TokenParsed } from '../token';
+import type { KeycloakLoginOptions, KeycloakLogoutOptions } from 'keycloak-js';
+import type { KeycloakMock } from '../types';
+import type { Session } from '../session/session';
+import { KeycloakContext } from './context';
+import { MultiPlatform } from 'multiplatform.one';
+import { getSession, useSession } from '../session/session';
+import { jwtDecode } from 'jwt-decode';
+import { signIn, signOut } from 'next-auth/react';
+import { useContext } from 'react';
+
+export class Keycloak {
+  token?: string;
+  idToken?: string;
+  refreshToken?: string;
+
+  private _idTokenParsed?: TokenParsed;
+  private _refreshTokenParsed?: TokenParsed;
+  private _tokenParsed?: AccessTokenParsed;
+  private keycloakClient?: KeycloakClient;
+  private mock: KeycloakMock | undefined;
+
+  constructor(input?: string | KeycloakClient | KeycloakMock | Session, idToken?: string, refreshToken?: string) {
+    if (typeof input === 'string') {
+      this.token = input;
+      this.idToken = idToken;
+      this.refreshToken = refreshToken;
+    } else if (typeof input === 'object') {
+      if (typeof (input as KeycloakClient).init === 'function') {
+        this.keycloakClient = input as KeycloakClient;
+      } else if ((input as Session).accessToken) {
+        const session = input as Session;
+        this.token = session.accessToken;
+        this.idToken = session.idToken;
+        this.refreshToken = session.refreshToken;
+      } else {
+        this.mock = input as KeycloakMock;
+      }
+    }
+    if (this.token && !this._tokenParsed) this._tokenParsed = jwtDecode(this.token) as AccessTokenParsed;
+    if (this.idToken && !this._idTokenParsed) this._idTokenParsed = jwtDecode(this.idToken) as TokenParsed;
+    if (this.refreshToken && !this._refreshTokenParsed) {
+      this._refreshTokenParsed = jwtDecode(this.refreshToken) as TokenParsed;
+    }
+  }
+
+  get tokenParsed() {
+    if (this.keycloakClient) return this.keycloakClient.tokenParsed as AccessTokenParsed;
+    return this._tokenParsed;
+  }
+
+  get idTokenParsed() {
+    if (this.keycloakClient) return this.keycloakClient.idTokenParsed as TokenParsed;
+    return this._idTokenParsed;
+  }
+
+  get refreshTokenParsed() {
+    if (this.keycloakClient) return this.keycloakClient.refreshTokenParsed as TokenParsed;
+    return this._refreshTokenParsed;
+  }
+
+  get clientId() {
+    if (this.keycloakClient) return this.keycloakClient.clientId;
+    return this.tokenParsed?.azp;
+  }
+
+  get email() {
+    if (this.keycloakClient) return this.keycloakClient.tokenParsed?.email;
+    if (this.mock) return this.mock.email;
+    return this.tokenParsed?.email;
+  }
+
+  get realm() {
+    if (this.keycloakClient) return this.keycloakClient.realm;
+    return this.tokenParsed?.iss?.split('/').pop();
+  }
+
+  get realmAccess() {
+    if (this.keycloakClient) return this.keycloakClient.realmAccess;
+    return this.tokenParsed?.realm_access;
+  }
+
+  get resourceAccess() {
+    if (this.keycloakClient) return this.keycloakClient.resourceAccess;
+    return this.tokenParsed?.resource_access;
+  }
+
+  get sessionId() {
+    if (this.keycloakClient) return this.keycloakClient.sessionId;
+    return this.tokenParsed?.session_state;
+  }
+
+  get subject() {
+    if (this.keycloakClient) return this.keycloakClient.subject;
+    return this.tokenParsed?.sub;
+  }
+
+  get username() {
+    if (this.mock) return this.mock.username;
+    return this.tokenParsed?.preferred_username;
+  }
+
+  async login(options: KeycloakLoginOptions = {}) {
+    if (this.keycloakClient) {
+      await this.keycloakClient.login(options);
+    } else if (MultiPlatform.isNext && !MultiPlatform.isServer) {
+      await signIn('keycloak', {
+        callbackUrl: options.redirectUri,
+      });
+    }
+  }
+
+  async logout(options: KeycloakLogoutOptions = {}) {
+    if (this.keycloakClient) {
+      await this.keycloakClient.logout(options);
+    } else if (MultiPlatform.isNext && !MultiPlatform.isServer) {
+      await fetch('/api/auth/logout', { method: 'GET' });
+      await signOut({
+        callbackUrl: options.redirectUri,
+      });
+    }
+  }
+
+  get authenticated() {
+    if (this.mock) return true;
+    if (this.keycloakClient) return !!this.keycloakClient.authenticated;
+    if (!this.tokenParsed?.exp || !this.idToken) return false;
+    return this.tokenParsed.exp > Date.now() / 1000;
+  }
+}
+
+export function useKeycloak() {
+  const keycloak = useContext(KeycloakContext);
+  if (keycloak) return keycloak;
+  const { session, status } = useSession();
+  if (MultiPlatform.isServer) return;
+  if (MultiPlatform.isStorybook) {
+    return new Keycloak({
+      email: 'storybook@example.com',
+      username: 'storybook',
+    });
+  } else if (status === 'unauthenticated') {
+    return new Keycloak();
+  } else if (status === 'authenticated' && session?.accessToken) {
+    return new Keycloak(session as Session);
+  }
+}
+
+export async function getKeycloak() {
+  const session = await getSession();
+  if (session?.accessToken) return new Keycloak(session as Session);
+  return new Keycloak();
+}