@multiplatform.one/keycloak 0.0.1

package/src/@types/expoKeycloakAuth.d.ts

@@ -0,0 +1,28 @@
+/**
+ * File: /src/@types/expoKeycloakAuth.d.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 25-11-2022 10:22:18
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 10:22:24
+ * 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.
+ */
+
+declare module "expo-keycloak-auth" {
+  export const KeycloakProvider: any;
+  export const useKeycloak: any;
+}

package/src/Authenticated.tsx

@@ -0,0 +1,56 @@
+/**
+ * File: /auth/Authenticated.tsx
+ * Project: app
+ * File Created: 08-11-2022 05:58:23
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 22-11-2022 06:26:38
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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, { ComponentType, FC, ReactNode } from "react";
+import { useLogin, useKeycloak } from "./hooks";
+
+export interface AuthenticatedProps {
+  children: ReactNode;
+  disabled?: boolean;
+  loggedOutComponent?: ComponentType;
+  loginRoute?: string;
+}
+
+export const Authenticated: FC<AuthenticatedProps> = (
+  props: AuthenticatedProps
+) => {
+  const { authenticated } = useKeycloak();
+  const login = useLogin(props.loginRoute);
+  if (!props.disabled && !authenticated) {
+    if (authenticated === false) login();
+    const LoggedOutComponent = props.loggedOutComponent || (() => null);
+    return <LoggedOutComponent />;
+  }
+  return <>{props.children}</>;
+};
+
+export function withAuthenticated<P extends object>(
+  Component: ComponentType<P>
+) {
+  return (props: P) => (
+    <Authenticated>
+      <Component {...props} />
+    </Authenticated>
+  );
+}

package/src/authConfig.ts

@@ -0,0 +1,38 @@
+/**
+ * File: /src/authConfig.ts
+ * Project: app
+ * File Created: 08-11-2022 09:21:15
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 10:29:29
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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 { createContext } from "react";
+
+export const defaultAuthConfig: AuthConfig = {
+  ssr: true,
+};
+
+export const AuthConfigContext = createContext<AuthConfig>(defaultAuthConfig);
+
+export interface AuthConfig {
+  debug?: boolean;
+  loginRoute?: string;
+  messageHandlerKeys?: string[];
+  ssr?: boolean;
+}

package/src/hooks/index.ts

@@ -0,0 +1,27 @@
+/**
+ * File: /src/hooks/index.ts
+ * Project: app
+ * File Created: 08-11-2022 06:34:56
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 09:52:31
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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.
+ */
+
+export * from "./useCurrentRouteName";
+export * from "./useKeycloak";
+export * from "./useLogin";

package/src/hooks/useAuthConfig.ts

@@ -0,0 +1,30 @@
+/**
+ * File: /src/hooks/useAuthConfig.ts
+ * Project: app
+ * File Created: 08-11-2022 09:20:41
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 09:52:31
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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 { AuthConfigContext } from "../authConfig";
+
+export function useAuthConfig() {
+  return useContext(AuthConfigContext);
+}

package/src/hooks/useCurrentRouteName.ts

@@ -0,0 +1,37 @@
+/**
+ * File: /src/hooks/useCurrentRouteName.ts
+ * Project: app
+ * File Created: 08-11-2022 08:38:23
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 10:24:27
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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 { MultiPlatform } from "multiplatform.one";
+import { useRoute } from "@react-navigation/native";
+import { useRouter } from "next/router";
+
+export function useCurrentRouteName() {
+  if (MultiPlatform.isStorybook()) return null;
+  if (MultiPlatform.isNext()) {
+    const router = useRouter();
+    return router.route;
+  }
+  const route = useRoute();
+  return route.name;
+}

package/src/hooks/useKeycloak/index.ts

@@ -0,0 +1,34 @@
+/**
+ * File: /src/hooks/useKeycloak/index.ts
+ * Project: app
+ * File Created: 08-11-2022 14:10:44
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 09:52:31
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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.
+ */
+
+export * from "./useKeycloak";
+
+export interface IKeycloak {
+  authenticated?: boolean;
+  token?: string;
+  refreshToken?: string;
+  tokenParsed?: any;
+  login: () => unknown;
+  logout: () => unknown;
+}

package/src/hooks/useKeycloak/useKeycloak.native.ts

@@ -0,0 +1,48 @@
+/**
+ * File: /src/hooks/useKeycloak/useKeycloak.native.ts
+ * Project: app
+ * File Created: 08-11-2022 14:10:25
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 10:21:56
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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 { useKeycloak as useKeycloakExpo } from "expo-keycloak-auth";
+import { MultiPlatform } from "multiplatform.one";
+import { IKeycloak } from "./index";
+
+export function useKeycloak() {
+  if (MultiPlatform.isStorybook()) return { authenticated: true } as IKeycloak;
+  const { ready, login, isLoggedIn, token, logout } = useKeycloakExpo();
+  const keycloak = new ExpoKeycloak(ready, isLoggedIn, login, logout, token);
+  return keycloak as IKeycloak;
+}
+
+export class ExpoKeycloak implements IKeycloak {
+  authenticated?: boolean;
+
+  constructor(
+    ready: boolean,
+    isLoggedIn: boolean,
+    public login: () => unknown,
+    public logout: () => unknown,
+    public token?: string
+  ) {
+    if (ready) this.authenticated = isLoggedIn;
+  }
+}

package/src/hooks/useKeycloak/useKeycloak.ts

@@ -0,0 +1,45 @@
+/**
+ * File: /src/hooks/useKeycloak/useKeycloak.ts
+ * Project: app
+ * File Created: 08-11-2022 06:04:59
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 10:22:57
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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 Keycloak from "keycloak-js";
+import { MultiPlatform } from "multiplatform.one";
+import { useKeycloak as useReactKeycloak } from "@react-keycloak/web";
+import { useKeycloak as useSsrKeycloak } from "@react-keycloak/ssr";
+import { IKeycloak } from "./index";
+import { useAuthConfig } from "../useAuthConfig";
+
+export function useKeycloak() {
+  const authConfig = useAuthConfig();
+  if (MultiPlatform.isStorybook()) return { authenticated: true } as IKeycloak;
+  if (MultiPlatform.isNext() && authConfig.ssr) {
+    const { keycloak: ssrKeycloak, initialized } = useSsrKeycloak();
+    const keycloak = { ...ssrKeycloak } as Keycloak;
+    if (!initialized) keycloak.authenticated = undefined;
+    return keycloak as IKeycloak;
+  }
+  const { keycloak: reactKeycloak, initialized } = useReactKeycloak();
+  const keycloak = { ...reactKeycloak } as Keycloak;
+  if (!initialized) keycloak.authenticated = undefined;
+  return keycloak as IKeycloak;
+}

package/src/hooks/useLogin.ts

@@ -0,0 +1,50 @@
+/**
+ * File: /src/hooks/useLogin.ts
+ * Project: app
+ * File Created: 08-11-2022 08:49:14
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 10:36:32
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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 { useRouter } from "@risserlabs/solito/router";
+import { MultiPlatform } from "multiplatform.one";
+import { useCurrentRouteName } from "./useCurrentRouteName";
+import { useKeycloak } from "./useKeycloak/useKeycloak";
+import { useAuthConfig } from "./useAuthConfig";
+
+export function useLogin(loginRoute?: string) {
+  if (MultiPlatform.isStorybook()) return () => null;
+  const keycloak = useKeycloak();
+  const authConfig = useAuthConfig();
+  const currentRouteName = useCurrentRouteName();
+  const router = useRouter();
+  return () => {
+    if (!loginRoute) loginRoute = authConfig.loginRoute;
+    if (!loginRoute) {
+      keycloak.login();
+      return;
+    }
+    const url = new URL(`x://${loginRoute}`);
+    const searchParams = new URLSearchParams(url.search);
+    if (currentRouteName) searchParams.append("backTo", currentRouteName);
+    let query = searchParams.toString();
+    if (query.length) query = `?${query}`;
+    router.push(`${url.pathname.substring(2)}${query}`);
+  };
+}

package/src/index.ts

@@ -0,0 +1,28 @@
+/**
+ * File: /src/index.ts
+ * Project: @multiplatform.one/keycloak
+ * File Created: 25-11-2022 09:51:55
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 25-11-2022 09:52:06
+ * 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.
+ */
+
+export * from "./Authenticated";
+export * from "./authConfig";
+export * from "./hooks";
+export * from "./provider";

package/src/provider/afterAuth.tsx

@@ -0,0 +1,56 @@
+/**
+ * File: /auth/provider/afterAuth.tsx
+ * Project: app
+ * File Created: 22-11-2022 17:49:58
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 22-11-2022 18:00:39
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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, { FC, ReactNode, useEffect } from "react";
+import { useKeycloak } from "../hooks";
+import { useAuthConfig } from "../hooks/useAuthConfig";
+import { useAuthState } from "../state";
+
+export interface AfterAuthProps {
+  children: ReactNode;
+}
+
+const logger = console;
+
+export const AfterAuth: FC<AfterAuthProps> = ({ children }: AfterAuthProps) => {
+  const authConfig = useAuthConfig();
+  const { token, refreshToken, authenticated } = useKeycloak();
+  const [, setAuth] = useAuthState();
+
+  useEffect(() => {
+    if (!authenticated) return;
+    if (token) {
+      setAuth({
+        token,
+        ...(refreshToken ? { refreshToken } : {}),
+      });
+    }
+  }, [token, refreshToken]);
+
+  if (authConfig.debug) {
+    logger.debug("authenticated", authenticated);
+    logger.debug("token", token);
+  }
+  return <>{children}</>;
+};

package/src/provider/index.tsx

@@ -0,0 +1,57 @@
+/**
+ * File: /auth/provider/index.tsx
+ * Project: app
+ * File Created: 08-11-2022 06:33:07
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 22-11-2022 18:00:13
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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, { FC, useMemo } from "react";
+import {
+  AuthConfig,
+  AuthConfigContext,
+  defaultAuthConfig,
+} from "../authConfig";
+import { KeycloakProvider, KeycloakProviderProps } from "./keycloakProvider";
+
+export interface AuthProviderProps extends KeycloakProviderProps {
+  authConfig?: Partial<AuthConfig>;
+}
+
+export const AuthProvider: FC<AuthProviderProps> = (
+  props: AuthProviderProps
+) => {
+  const { authConfig, debug } = props;
+  const authConfigValue = useMemo(
+    () => ({
+      ...defaultAuthConfig,
+      ...authConfig,
+      debug: !!debug,
+    }),
+    []
+  );
+
+  return (
+    <AuthConfigContext.Provider value={authConfigValue}>
+      <KeycloakProvider {...props} />
+    </AuthConfigContext.Provider>
+  );
+};
+
+export * from "./keycloakProvider";

package/src/provider/keycloakProvider.native.tsx

@@ -0,0 +1,42 @@
+/**
+ * File: /auth/provider/keycloakProvider.native.tsx
+ * Project: app
+ * File Created: 08-11-2022 03:12:37
+ * Author: Clay Risser
+ * -----
+ * Last Modified: 22-11-2022 17:52:31
+ * Modified By: Clay Risser
+ * -----
+ * Risser Labs LLC (c) Copyright 2021 - 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 { KeycloakProvider as ExpoKeycloakProvider } from "expo-keycloak-auth";
+import React, { FC } from "react";
+import type { KeycloakProviderProps } from "./keycloakProvider";
+import { AfterAuth } from "./afterAuth";
+
+export const KeycloakProvider: FC<KeycloakProviderProps> = ({
+  children,
+  keycloakConfig,
+}: KeycloakProviderProps & { keycloakConfig: { url?: string } }) => {
+  keycloakConfig.url = keycloakConfig.baseUrl;
+  // @ts-ignore
+  delete keycloakConfig.baseUrl;
+  return (
+    <ExpoKeycloakProvider {...keycloakConfig}>
+      <AfterAuth>{children}</AfterAuth>
+    </ExpoKeycloakProvider>
+  );
+};