@multiplatform.one/keycloak 3.0.0 → 5.0.1

package/src/keycloak/keycloak.native.ts

@@ -1,182 +0,0 @@
-/*
- * File: /src/keycloak/keycloak.native.ts
- * Project: @multiplatform.one/keycloak
- * File Created: 04-04-2024 15:50:39
- * 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 { KeycloakConfig } from 'keycloak-js';
-import type { KeycloakLoginOptions, KeycloakLogoutOptions } from '../keycloak';
-import type { KeycloakMock } from '../types';
-import { KeycloakConfigContext } from '../keycloak/config';
-import { KeycloakContext } from './context';
-import { MultiPlatform } from 'multiplatform.one';
-import { jwtDecode } from 'jwt-decode';
-import { useContext } from 'react';
-
-export class Keycloak {
-  token?: string;
-  idToken?: string;
-  refreshToken?: string;
-
-  private _idTokenParsed?: TokenParsed;
-  private _login?: (_options: KeycloakLoginOptions) => Promise<undefined>;
-  private _logout?: (_options: KeycloakLogoutOptions) => Promise<undefined>;
-  private _refreshTokenParsed?: TokenParsed;
-  private _tokenParsed?: AccessTokenParsed;
-  private keycloakClient?: KeycloakClient;
-  private mock: KeycloakMock | undefined;
-
-  constructor(
-    public readonly config: KeycloakConfig,
-    input?: string | KeycloakClient | KeycloakMock,
-    idToken?: string,
-    refreshToken?: string,
-    login?: (_options: KeycloakLoginOptions) => Promise<undefined>,
-    logout?: (_options: KeycloakLogoutOptions) => Promise<undefined>,
-  ) {
-    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;
-    }
-    this._login = login;
-    this._logout = logout;
-  }
-
-  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 || this.config.clientId;
-  }
-
-  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() || this.config.realm;
-  }
-
-  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 getUserInfo() {
-    if (!this.authenticated) return;
-    const response = await fetch(`${this.config.url}/realms/${this.config.realm}/protocol/openid-connect/userinfo`, {
-      method: 'GET',
-      headers: {
-        Authorization: 'Bearer ' + this.token,
-        Accept: 'application/json',
-      },
-    });
-    if (response.ok) return response.json();
-  }
-
-  async login(options: KeycloakLoginOptions = {}) {
-    this.idToken = undefined;
-    this.refreshToken = undefined;
-    this.token = undefined;
-    if (this.keycloakClient) {
-      await this.keycloakClient.login(options);
-    } else {
-      await this._login?.(options);
-    }
-  }
-
-  async logout(options: KeycloakLogoutOptions = {}) {
-    this.idToken = undefined;
-    this.refreshToken = undefined;
-    this.token = undefined;
-    if (this.keycloakClient) {
-      await this.keycloakClient.logout(options);
-    } else {
-      await this._logout?.(options);
-    }
-  }
-
-  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);
-  const keycloakConfig = useContext(KeycloakConfigContext);
-  if (keycloak) return keycloak;
-  if (MultiPlatform.isStorybook) {
-    return new Keycloak(keycloakConfig, {
-      email: 'storybook@example.com',
-      username: 'storybook',
-    });
-  }
-}

package/src/keycloak/keycloak.ts

@@ -1,214 +0,0 @@
-/*
- * File: /src/keycloak/keycloak.ts
- * Project: @multiplatform.one/keycloak
- * File Created: 04-04-2024 15:50:39
- * 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 { AuthRequestPromptOptions } from 'expo-auth-session';
-import type { KeycloakMock } from '../types';
-import type { Session } from '../session/session';
-import { KeycloakConfigContext, type KeycloakConfig } from './config';
-import { KeycloakContext } from './context';
-import { MultiPlatform } from 'multiplatform.one';
-import { useSession } from '../session/session';
-import { jwtDecode } from 'jwt-decode';
-import { signIn, signOut } from 'next-auth/react';
-import { useAuthConfig } from '../hooks';
-import { useContext } from 'react';
-import type {
-  KeycloakLoginOptions as KeycloakJsLoginOptions,
-  KeycloakLogoutOptions as KeycloakJsLogoutOptions,
-} from 'keycloak-js';
-
-export type KeycloakLoginOptions = KeycloakJsLoginOptions & AuthRequestPromptOptions & { redirect?: boolean };
-export type KeycloakLogoutOptions = KeycloakJsLogoutOptions;
-
-export class Keycloak {
-  token?: string;
-  idToken?: string;
-  refreshToken?: string;
-
-  private _idTokenParsed?: TokenParsed;
-  private _login?: (_options: KeycloakLoginOptions) => Promise<undefined>;
-  private _logout?: (_options: KeycloakLogoutOptions) => Promise<undefined>;
-  private _refreshTokenParsed?: TokenParsed;
-  private _tokenParsed?: AccessTokenParsed;
-  private keycloakClient?: KeycloakClient;
-  private mock: KeycloakMock | undefined;
-
-  constructor(
-    public readonly config: KeycloakConfig,
-    input?: string | KeycloakClient | KeycloakMock | Session,
-    idToken?: string,
-    refreshToken?: string,
-    login?: (_options: KeycloakLoginOptions) => Promise<undefined>,
-    logout?: (_options: KeycloakLogoutOptions) => Promise<undefined>,
-  ) {
-    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;
-    }
-    this._login = login;
-    this._logout = logout;
-  }
-
-  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 || this.config.clientId;
-  }
-
-  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() || this.config.realm;
-  }
-
-  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 getUserInfo() {
-    if (!this.authenticated) return;
-    const response = await fetch(`${this.config.url}/realms/${this.config.realm}/protocol/openid-connect/userinfo`, {
-      method: 'GET',
-      headers: {
-        Authorization: 'Bearer ' + this.token,
-        Accept: 'application/json',
-      },
-    });
-    if (response.ok) return response.json();
-  }
-
-  async login(options: KeycloakLoginOptions = {}) {
-    this.idToken = undefined;
-    this.refreshToken = undefined;
-    this.token = undefined;
-    if (this.keycloakClient) {
-      await this.keycloakClient.login(options);
-    } else if (MultiPlatform.isNext && !MultiPlatform.isServer) {
-      await signIn('keycloak', {
-        callbackUrl: options.redirectUri,
-        redirect: options.redirect,
-      });
-    } else {
-      await this._login?.(options);
-    }
-  }
-
-  async logout(options: KeycloakLogoutOptions = {}) {
-    this.idToken = undefined;
-    this.refreshToken = undefined;
-    this.token = undefined;
-    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,
-      });
-    } else {
-      await this._logout?.(options);
-    }
-  }
-
-  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);
-  const keycloakConfig = useContext(KeycloakConfigContext);
-  const { disabled } = useAuthConfig();
-  if (disabled) return null;
-  if (keycloak) return keycloak;
-  const { session, status } = useSession();
-  if (MultiPlatform.isStorybook) {
-    return new Keycloak(keycloakConfig, {
-      email: 'storybook@example.com',
-      username: 'storybook',
-    });
-  } else if (status === 'unauthenticated') {
-    return new Keycloak(keycloakConfig);
-  } else if (status === 'authenticated' && session?.accessToken) {
-    return new Keycloak(keycloakConfig, session as Session);
-  }
-}

package/src/provider/AuthProvider/AuthProvider.native.tsx

@@ -1,194 +0,0 @@
-/**
- * File: /src/provider/AuthProvider/AuthProvider.native.tsx
- * Project: @multiplatform.one/keycloak
- * File Created: 09-01-2024 11:29:20
- * 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 React, { useState, useEffect, useMemo, useCallback } from 'react';
-import type { AuthProviderProps, Tokens } from './AuthProvider';
-import type { KeycloakLoginOptions, KeycloakLogoutOptions } from '../../keycloak';
-import { AfterAuth } from '../AfterAuth';
-import { Keycloak, KeycloakConfigContext } from '../../keycloak';
-import { KeycloakContext } from '../../keycloak/context';
-import { makeRedirectUri, useAuthRequest, useAutoDiscovery, refreshAsync, exchangeCodeAsync } from 'expo-auth-session';
-import { persist, useAuthState } from '../../state';
-import { validOrRefreshableToken, isTokenExpired } from '../../token';
-
-const REFRESH_THRESHOLD = 5;
-
-export function AuthProvider({ children, keycloakConfig }: AuthProviderProps) {
-  const [keycloak, setKeycloak] = useState<Keycloak>();
-  const authState = useAuthState();
-  const initialRefreshToken = useMemo(() => validOrRefreshableToken((persist && authState.refreshToken) || false), []);
-  const keycloakUrl = `${keycloakConfig?.url}/realms/${keycloakConfig?.realm}`;
-  const clientId = keycloakConfig.publicClientId || keycloakConfig?.clientId || '';
-  const discovery = useAutoDiscovery(keycloakUrl);
-  const redirectUri = makeRedirectUri();
-  const [tokens, setTokens] = useState<Tokens<false>>({
-    refreshToken: initialRefreshToken,
-    token: validOrRefreshableToken((persist && authState.token) || false, initialRefreshToken),
-    idToken: validOrRefreshableToken((persist && authState.idToken) || false, initialRefreshToken),
-  });
-  const scopes = useMemo(
-    () => [...new Set(['email', 'openid', 'profile', ...(keycloakConfig.scopes || [])])],
-    [keycloakConfig.scopes],
-  );
-  const [request, response, promptAsync] = useAuthRequest(
-    {
-      clientId,
-      redirectUri: redirectUri,
-      scopes,
-    },
-    discovery,
-  );
-
-  useEffect(() => {
-    if (!discovery || !response?.type || !request?.codeVerifier || !clientId) return;
-    (async () => {
-      if (response?.type === 'success' && request.codeVerifier && response.params.code) {
-        const tokenResponse = await exchangeCodeAsync(
-          {
-            clientId,
-            code: response.params.code,
-            redirectUri,
-            scopes,
-            extraParams: {
-              code_verifier: request.codeVerifier,
-            },
-          },
-          discovery,
-        );
-        if (tokenResponse) {
-          setTokens({
-            idToken: tokenResponse.idToken,
-            refreshToken: tokenResponse.refreshToken,
-            token: tokenResponse.accessToken,
-          });
-        }
-      }
-    })();
-  }, [
-    !discovery,
-    request?.codeVerifier,
-    response?.type === 'success' ? response?.params?.code : undefined,
-    clientId,
-    scopes,
-    redirectUri,
-  ]);
-
-  const resetTokens = useCallback(() => {
-    authState.setIdToken('');
-    authState.setRefreshToken('');
-    authState.setToken('');
-    setTokens({
-      refreshToken: undefined,
-      token: undefined,
-      idToken: undefined,
-    });
-  }, []);
-
-  const refreshTokens = useCallback(async () => {
-    if (!discovery) return;
-    if (typeof tokens.refreshToken === 'string') {
-      if (!isTokenExpired(tokens.refreshToken)) {
-        const tokenResponse = await refreshAsync(
-          {
-            clientId,
-            refreshToken: tokens.refreshToken,
-            scopes,
-          },
-          discovery,
-        );
-        if (tokenResponse) {
-          setTokens({
-            idToken: tokenResponse.idToken,
-            refreshToken: tokenResponse.refreshToken,
-            token: tokenResponse.accessToken,
-          });
-        } else {
-          resetTokens();
-        }
-      } else {
-        resetTokens();
-      }
-    } else if (
-      authState.refreshToken &&
-      typeof authState.refreshToken === 'string' &&
-      isTokenExpired(authState.refreshToken)
-    ) {
-      resetTokens();
-    }
-  }, [!discovery, tokens.refreshToken, clientId, scopes]);
-
-  useEffect(() => {
-    if (!discovery) return;
-    refreshTokens();
-  }, [!discovery]);
-
-  useEffect(() => {
-    if (!request) return;
-    let refreshHandle: NodeJS.Timeout;
-    (async () => {
-      if (tokens.token && isTokenExpired(tokens.token)) {
-        await refreshTokens();
-      } else {
-        const _keycloak = new Keycloak(
-          keycloakConfig,
-          tokens.token || undefined,
-          tokens.idToken || undefined,
-          tokens.refreshToken || undefined,
-          async (options: KeycloakLoginOptions) => {
-            await promptAsync(options);
-          },
-          async (_options: KeycloakLogoutOptions) => {
-            resetTokens();
-          },
-        );
-        if (_keycloak.tokenParsed?.exp) {
-          const timeout =
-            Math.max(
-              Math.min(_keycloak.tokenParsed.exp, _keycloak.refreshTokenParsed?.exp || 0) -
-                Math.floor(Date.now() / 1000) -
-                REFRESH_THRESHOLD,
-              REFRESH_THRESHOLD,
-            ) * 1000;
-          if (timeout > 0) {
-            refreshHandle = setTimeout(() => {
-              refreshTokens();
-            }, timeout);
-          } else {
-            setTimeout(() => _keycloak.logout(), Math.max(0, timeout + REFRESH_THRESHOLD) * 1000);
-            return;
-          }
-        }
-        setKeycloak(_keycloak);
-      }
-    })();
-    return () => {
-      if (refreshHandle) clearTimeout(refreshHandle);
-    };
-  }, [!request, tokens.token, tokens.idToken, tokens.refreshToken, refreshTokens]);
-
-  return (
-    <KeycloakConfigContext.Provider value={keycloakConfig}>
-      <KeycloakContext.Provider value={keycloak}>
-        <AfterAuth>{children}</AfterAuth>
-      </KeycloakContext.Provider>
-    </KeycloakConfigContext.Provider>
-  );
-}