@multiplatform.one/keycloak 0.0.1 → 0.0.3

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["/**\n * File: /src/types.ts\n * Project: @multiplatform.one/keycloak\n * File Created: 25-11-2022 10:27:53\n * Author: Clay Risser\n * -----\n * Last Modified: 25-11-2022 10:28:25\n * Modified By: Clay Risser\n * -----\n * Risser Labs LLC (c) Copyright 2022\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\ndeclare global {\n  interface Window {\n    ReactNativeWebView: {\n      postMessage: (body: string) => unknown;\n    };\n    webkit: {\n      messageHandlers: {\n        [key: string]: {\n          postMessage: (body: string) => unknown;\n        };\n      };\n    };\n  }\n}\n\nexport default null;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAtBA,eAuCe,IAAI;EAAA;AAAA"}
+{"version":3,"file":"types.js","names":[],"sources":["../src/types.ts"],"sourcesContent":["/**\n * File: /src/types.ts\n * Project: @multiplatform.one/keycloak\n * File Created: 25-11-2022 10:27:53\n * Author: Clay Risser\n * -----\n * Last Modified: 25-11-2022 10:28:25\n * Modified By: Clay Risser\n * -----\n * Risser Labs LLC (c) Copyright 2022\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\ndeclare global {\n  interface Window {\n    ReactNativeWebView: {\n      postMessage: (body: string) => unknown;\n    };\n    webkit: {\n      messageHandlers: {\n        [key: string]: {\n          postMessage: (body: string) => unknown;\n        };\n      };\n    };\n  }\n}\n\nexport default null;\n"],"mappings":";;;;;;;;;;;;;;;;;;;EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EAtBA,eAuCe,IAAI;EAAA;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@multiplatform.one/keycloak",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "keycloak client for multiplatform.one ecosystem",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -88,7 +88,7 @@
     "babel-plugin-transform-typescript-metadata": "^0.3.2",
     "browserlist": "^1.0.1",
     "core-js": "^3.26.1",
-    "cspell": "^6.14.3",
+    "cspell": "^6.15.0",
     "dripsy": "^3.8.1",
     "eslint": "^8.28.0",
     "eslint-config-alloy": "^4.7.0",
@@ -97,7 +97,7 @@
     "jest": "^29.3.1",
     "jest-sonar-reporter": "^2.0.0",
     "lockfile-lint": "^4.9.6",
-    "multiplatform.one": "^0.0.1",
+    "multiplatform.one": "^0.0.2",
     "next": "^13.0.5",
     "prettier": "^2.8.0",
     "react": "^18.2.0",
@@ -135,7 +135,8 @@
   "dependencies": {
     "@react-keycloak/ssr": "^3.3.0",
     "@react-keycloak/web": "^3.4.0",
-    "expo-keycloak-auth": "^1.0.14",
+    "@react-native-async-storage/async-storage": "^1.17.11",
+    "expo-auth-session": "^3.7.2",
     "keycloak-js": "^20.0.1"
   }
 }

package/src/expo/ExpoKeycloakContext.ts

@@ -0,0 +1,41 @@
+/**
+ * File: /src/expo/ExpoKeycloakContext.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 26-11-2022 06:58:16
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 26-11-2022 08:38:25
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2022
+ *
+ * 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 {
+  AuthRequestPromptOptions,
+  AuthSessionResult,
+  TokenResponse,
+} from "expo-auth-session";
+import { createContext } from "react";
+import { KC_INITIAL_VALUE } from "./const";
+
+export const ExpoKeycloakContext = createContext<{
+  ready: boolean;
+  isLoggedIn?: boolean;
+  login: (
+    options?: AuthRequestPromptOptions
+  ) => Promise<AuthSessionResult | undefined>;
+  logout: () => undefined;
+  token: TokenResponse | null;
+}>(KC_INITIAL_VALUE);

package/src/expo/ExpoKeycloakProvider.tsx

@@ -0,0 +1,139 @@
+/**
+ * File: /src/expo/KeycloakProvider.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 26-11-2022 06:58:16
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 26-11-2022 08:06:40
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2022
+ *
+ * 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, { ReactNode, useCallback, useEffect } from "react";
+import { Platform } from "react-native";
+import * as AuthSession from "expo-auth-session";
+import {
+  useAuthRequest,
+  useAutoDiscovery,
+  AuthRequestConfig,
+} from "expo-auth-session";
+import { ExpoKeycloakContext } from "./ExpoKeycloakContext";
+import { useTokenStorage } from "./useTokenStorage";
+import { handleTokenExchange, getRealmURL } from "./helpers";
+import { NATIVE_REDIRECT_PATH } from "./const";
+
+export interface IKeycloakConfiguration extends Partial<AuthRequestConfig> {
+  children: ReactNode;
+  clientId: string;
+  disableAutoRefresh?: boolean;
+  nativeRedirectPath?: string;
+  realm: string;
+  refreshTimeBuffer?: number;
+  scheme?: string;
+  tokenStorageKey?: string;
+  url: string;
+}
+
+export const ExpoKeycloakProvider = ({
+  realm,
+  clientId,
+  url,
+  extraParams,
+  children,
+  ...options
+}: IKeycloakConfiguration) => {
+  const discovery = useAutoDiscovery(getRealmURL({ realm, url }));
+  const redirectUri = AuthSession.makeRedirectUri({
+    native: `${options.scheme ?? "exp"}://${
+      options.nativeRedirectPath ?? NATIVE_REDIRECT_PATH
+    }`,
+    useProxy: !options.scheme,
+  });
+  const config = {
+    clientId,
+    extraParams,
+    realm,
+    redirectUri,
+    url,
+  };
+  const [request, response, promptAsync] = useAuthRequest(
+    { usePKCE: false, ...config },
+    discovery
+  );
+  const [currentToken, updateToken] = useTokenStorage(
+    options,
+    config,
+    discovery!
+  );
+
+  const handleLogin = useCallback(
+    (options: AuthSession.AuthRequestPromptOptions = {}) =>
+      promptAsync(options),
+    [request]
+  );
+
+  function handleLogout() {
+    if (!currentToken) throw new Error("Not logged in.");
+    try {
+      if (discovery?.revocationEndpoint) {
+        AuthSession.revokeAsync(
+          { token: currentToken?.accessToken, ...config },
+          discovery
+        );
+      }
+      if (discovery?.endSessionEndpoint) {
+        fetch(`${discovery.endSessionEndpoint}`, {
+          method: "POST",
+          headers: {
+            "Content-Type": "application/x-www-form-urlencoded",
+          },
+          body: `client_id=${clientId}&refresh_token=${currentToken.refreshToken}`,
+        });
+      }
+      if (Platform.OS === "ios") {
+        AuthSession.dismiss();
+      }
+    } catch (error) {
+      console.log(error);
+    }
+    updateToken(null);
+    return undefined;
+  }
+
+  useEffect(() => {
+    if (response) {
+      handleTokenExchange({ response, discovery: discovery!, config }).then(
+        updateToken
+      );
+    }
+  }, [response]);
+
+  return (
+    <ExpoKeycloakContext.Provider
+      // eslint-disable-next-line react/jsx-no-constructed-context-values
+      value={{
+        isLoggedIn: currentToken === undefined ? undefined : !!currentToken,
+        login: handleLogin,
+        logout: handleLogout,
+        ready:
+          discovery !== null && request !== null && currentToken !== undefined,
+        token: currentToken,
+      }}
+    >
+      {children}
+    </ExpoKeycloakContext.Provider>
+  );
+};

package/src/expo/NOTES

@@ -0,0 +1 @@
+This folder contains code by rubhiauliatirta (https://github.com/rubhiauliatirta)

package/src/expo/const.ts

@@ -0,0 +1,42 @@
+/**
+ * File: /src/expo/const.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 26-11-2022 06:58:16
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 26-11-2022 08:17:10
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2022
+ *
+ * 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.
+ */
+
+const logger = console;
+
+export const KC_INITIAL_VALUE = {
+  ready: false,
+  isLoggedIn: false,
+  login: async () => {
+    logger.error("kc not initialized");
+    return undefined;
+  },
+  logout: () => {
+    logger.error("not logged in");
+    return undefined;
+  },
+  token: null,
+};
+export const NATIVE_REDIRECT_PATH = "auth/redirect";
+export const TOKEN_STORAGE_KEY = "keycloak_token";
+export const REFRESH_TIME_BUFFER = 20;

package/src/expo/helpers.ts

@@ -0,0 +1,74 @@
+/**
+ * File: /src/expo/helpers.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 26-11-2022 06:58:16
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 26-11-2022 08:11:15
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2022
+ *
+ * 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 {
+  AccessTokenRequestConfig,
+  exchangeCodeAsync,
+  DiscoveryDocument,
+  AuthSessionResult,
+} from "expo-auth-session";
+
+export function getRealmURL(config: RealmURLConfig) {
+  const { url, realm } = config;
+  const slash = url.endsWith("/") ? "" : "/";
+  return `${url + slash}realms/${encodeURIComponent(realm)}`;
+}
+
+export function getCurrentTimeInSeconds() {
+  return Math.floor(Date.now() / 1000);
+}
+
+export async function handleTokenExchange({
+  response,
+  discovery,
+  config,
+}: TokenExchange) {
+  try {
+    if (response?.type === "success" && !!discovery?.tokenEndpoint) {
+      return exchangeCodeAsync(
+        { code: response.params.code, ...config },
+        discovery
+      );
+    }
+    if (response?.type === "error") return null;
+    return null;
+  } catch (error) {
+    return null;
+  }
+}
+
+export interface TokenExchange {
+  response: AuthSessionResult;
+  discovery: Pick<DiscoveryDocument, "tokenEndpoint">;
+  config: Omit<AccessTokenRequestConfig, "code"> & { code?: string };
+}
+
+export interface TokenExchangeDiscovery {
+  tokenEndpoint?: string;
+}
+
+export interface RealmURLConfig {
+  realm: string;
+  url: string;
+}

package/src/{@types/expoKeycloakAuth.d.ts → expo/index.ts}

@@ -1,10 +1,10 @@
 /**
- * File: /src/@types/expoKeycloakAuth.d.ts
+ * File: /src/expo/index.ts
  * Project: @multiplatform.one/keycloak
- * File Created: 25-11-2022 10:22:18
+ * File Created: 26-11-2022 06:58:16
  * Author: Clay Risser
  * -----
- * Last Modified: 25-11-2022 10:22:24
+ * Last Modified: 26-11-2022 08:38:41
  * Modified By: Clay Risser
  * -----
  * Risser Labs LLC (c) Copyright 2022
@@ -22,7 +22,6 @@
  * limitations under the License.
  */
 
-declare module "expo-keycloak-auth" {
-  export const KeycloakProvider: any;
-  export const useKeycloak: any;
-}
+export * from "./ExpoKeycloakProvider";
+export * from "./useExpoKeycloak";
+export * from "./const";

package/src/expo/useExpoKeycloak.ts

@@ -0,0 +1,44 @@
+/**
+ * File: /src/expo/useExpoKeycloak.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 26-11-2022 06:58:16
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 26-11-2022 08:38:57
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2022
+ *
+ * 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 { useContext } from "react";
+import { ExpoKeycloakContext } from "./ExpoKeycloakContext";
+
+export function useExpoKeycloak() {
+  const {
+    isLoggedIn,
+    login,
+    logout,
+    ready = false,
+    token = null,
+  } = useContext(ExpoKeycloakContext);
+  return {
+    isLoggedIn,
+    login,
+    logout,
+    ready,
+    token: token?.accessToken ?? null,
+    refreshToken: token?.refreshToken ?? null,
+  };
+}

package/src/expo/useTokenStorage.ts

@@ -0,0 +1,168 @@
+/**
+ * File: /src/expo/useTokenStorage.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 26-11-2022 06:58:16
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 26-11-2022 08:08:00
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2022
+ *
+ * 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 { AppState, AppStateStatus, Platform } from "react-native";
+import { DiscoveryDocument, refreshAsync } from "expo-auth-session";
+import { REFRESH_TIME_BUFFER, TOKEN_STORAGE_KEY } from "./const";
+import { dismiss, revokeAsync, TokenResponse } from "expo-auth-session";
+import { getCurrentTimeInSeconds } from "./helpers";
+import { useAsyncStorage } from "@react-native-async-storage/async-storage";
+import { useEffect, useRef, useState } from "react";
+
+const logger = console;
+
+export function useTokenStorage(
+  {
+    disableAutoRefresh = false,
+    refreshTimeBuffer = REFRESH_TIME_BUFFER,
+    tokenStorageKey = TOKEN_STORAGE_KEY,
+  },
+  config: {
+    clientId: string;
+    extraParams?: Record<string, string>;
+    realm: string;
+    redirectUri: string;
+    url: string;
+  },
+  discovery: DiscoveryDocument
+): [TokenResponse | null, (token: TokenResponse | null) => Promise<void>] {
+  const [token, setToken] = useState<TokenResponse | null>();
+  const { getItem, setItem, removeItem } = useAsyncStorage(tokenStorageKey);
+  const refreshHandler = useRef<NodeJS.Timeout>(null);
+  const appState = useRef(AppState.currentState);
+  const refreshTime = useRef<number>(null);
+  const tokenData = useRef<TokenResponse>(null);
+
+  async function updateAndSaveToken(newToken: TokenResponse | null) {
+    try {
+      setToken(newToken);
+      if (newToken !== null) {
+        const stringifiedValue = JSON.stringify(newToken);
+        await setItem(stringifiedValue);
+      } else {
+        await removeItem();
+      }
+    } catch (error) {
+      logger.error(error);
+    }
+  }
+
+  async function handleTokenRefresh(token: TokenResponse | null) {
+    try {
+      const tokenResponse = await refreshAsync(
+        { refreshToken: token?.refreshToken, ...config },
+        discovery
+      );
+      updateAndSaveToken(tokenResponse);
+    } catch (err) {
+      updateAndSaveToken(null);
+    }
+  }
+
+  useEffect(() => {
+    function handleAppState(nextAppState: AppStateStatus) {
+      if (
+        appState.current.match(/inactive|background/) &&
+        nextAppState === "active"
+      ) {
+        if (refreshHandler.current !== null) {
+          clearTimeout(refreshHandler.current);
+          const now = getCurrentTimeInSeconds();
+          if (Number(refreshTime.current) <= now) {
+            setToken(null);
+          } else {
+            const timeout = 1000 * (Number(refreshTime.current) - now);
+            // @ts-ignore
+            refreshHandler.current = setTimeout(() => {
+              handleTokenRefresh(tokenData.current);
+            }, timeout);
+          }
+        }
+      }
+      appState.current = nextAppState;
+    }
+    const subscription = AppState.addEventListener("change", handleAppState);
+    return () => {
+      if (subscription) {
+        subscription.remove();
+      } else {
+        // @ts-ignore
+        AppState.removeEventListener("change", handleAppState);
+      }
+    };
+  }, []);
+
+  useEffect(() => {
+    async function getTokenFromStorage() {
+      try {
+        const tokenFromStorage = await getItem();
+        if (!tokenFromStorage) throw new Error("No token in storage");
+        const token = JSON.parse(tokenFromStorage);
+        if (!TokenResponse.isTokenFresh(token, -refreshTimeBuffer)) {
+          handleTokenRefresh(token);
+        } else {
+          setToken(token);
+        }
+      } catch (error) {
+        setToken(null);
+      }
+    }
+    if (discovery) getTokenFromStorage();
+  }, [discovery]);
+
+  useEffect(() => {
+    // trigger every token update
+    // @ts-ignore
+    tokenData.current = token || null;
+    if (token !== undefined && !disableAutoRefresh) {
+      if (refreshHandler.current !== null) {
+        clearTimeout(refreshHandler.current);
+      }
+      if (token?.expiresIn) {
+        const now = getCurrentTimeInSeconds();
+        // @ts-ignore
+        refreshTime.current =
+          token.issuedAt + token.expiresIn - refreshTimeBuffer;
+        const timeout = 1000 * (refreshTime.current - now);
+        // @ts-ignore
+        refreshHandler.current = setTimeout(() => {
+          handleTokenRefresh(token);
+        }, timeout);
+      }
+      if (token === null && tokenData.current !== null) {
+        revokeAsync(
+          { token: tokenData.current?.accessToken, ...config },
+          discovery
+        );
+        Platform.OS === "ios" && dismiss();
+        // @ts-ignore
+        refreshTime.current = null;
+        // @ts-ignore
+        tokenData.current = null;
+      }
+    }
+  }, [token]);
+
+  return [token || null, updateAndSaveToken];
+}

package/src/hooks/useKeycloak/index.ts

@@ -4,7 +4,7 @@
  * File Created: 08-11-2022 14:10:44
  * Author: Clay Risser
  * -----
- * Last Modified: 25-11-2022 09:52:31
+ * Last Modified: 26-11-2022 08:31:01
  * Modified By: Clay Risser
  * -----
  * Risser Labs LLC (c) Copyright 2021 - 2022
@@ -22,13 +22,20 @@
  * limitations under the License.
  */
 
+import type {
+  KeycloakResourceAccess,
+  KeycloakRoles,
+  KeycloakTokenParsed,
+} from "keycloak-js";
 export * from "./useKeycloak";
 
 export interface IKeycloak {
   authenticated?: boolean;
   token?: string;
   refreshToken?: string;
-  tokenParsed?: any;
-  login: () => unknown;
-  logout: () => unknown;
+  tokenParsed?: KeycloakTokenParsed;
+  realmAccess?: KeycloakRoles;
+  resourceAccess?: KeycloakResourceAccess;
+  login: () => Promise<unknown> | unknown;
+  logout: () => Promise<unknown> | unknown;
 }