@react-keycloak-refork/core 6.0.0 → 8.0.2

package/LICENSE.md

@@ -1,24 +1,24 @@
-MIT License
-
-Copyright (c) 2019-present, Mattia Panzeri <mattia.panzeri93@gmail.com>
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without
-restriction, including without limitation the rights to use,
-copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the
-Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
-OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-OTHER DEALINGS IN THE SOFTWARE.
+MIT License
+
+Copyright (c) 2019-present, Mattia Panzeri <mattia.panzeri93@gmail.com>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,150 +1,149 @@
-![React Keycloak](/art/react-keycloak-logo.png?raw=true 'React Keycloak Logo')
-
-# React Keycloak (Keycloak >=v26 Fork) <!-- omit in toc -->
-
-> React bindings for [Keycloak](https://www.keycloak.org/). Fork of https://github.com/react-keycloak/react-keycloak.git with updated packages for keycloak >=26 support.
-
-⚠️ **IMPORTANT NOTICE**: This fork has been updated to support Keycloak 26, but it is **NOT MAINTAINED**. We strongly recommend migrating to [NextAuth.js](https://next-auth.js.org/) for new projects, as it provides better maintenance, security updates, and broader OAuth provider support.
-
-[![NPM (scoped)](https://img.shields.io/npm/v/@react-keycloak-refork/core?label=npm%20%7C%20core)](https://www.npmjs.com/package/@react-keycloak-refork/core)
-[![NPM (scoped)](https://img.shields.io/npm/v/@react-keycloak-refork/web?label=npm%20%7C%20web)](https://www.npmjs.com/package/@react-keycloak-refork/web)
-[![NPM (scoped)](https://img.shields.io/npm/v/@react-keycloak-refork/ssr?label=npm%20%7C%20ssr)](https://www.npmjs.com/package/@react-keycloak-refork/ssr)
-[![NPM (scoped)](https://img.shields.io/npm/v/@react-keycloak-refork/native?label=npm%20%7C%20native)](https://www.npmjs.com/package/@react-keycloak-refork/native)
-
-[![License](https://img.shields.io/github/license/react-keycloak/react-keycloak.svg)](https://github.com/react-keycloak/react-keycloak-fork/blob/master/LICENSE.md)
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
-[![GitHub contributors](https://img.shields.io/github/contributors/react-keycloak/react-keycloak)](https://github.com/react-keycloak/react-keycloak-fork/graphs/contributors)
-[![Github Issues](https://img.shields.io/github/issues/react-keycloak/react-keycloak.svg)](https://github.com/react-keycloak/react-keycloak/issues) ![npm](https://img.shields.io/npm/dm/@react-keycloak-refork/core)
-
-[![Gitter](https://img.shields.io/gitter/room/react-keycloak/community)](https://gitter.im/react-keycloak/community)
-
----
-
-## Table of Contents <!-- omit in toc -->
-
-- [Integrations](#integrations)
-  - [React](#react)
-  - [SSR](#ssr)
-  - [React Native](#react-native)
-- [Support](#support)
-- [Examples](#examples)
-- [Alternatives](#alternatives)
-- [Contributing](#contributing)
-- [License](#license)
-
----
-
-## Integrations
-
-### React
-
-React Keycloak for Web requires:
-
-- React **16.0** or later
-- `keycloak-js` **26.0.0** or later
-
-```shell
-yarn add @react-keycloak-refork/web
-```
-
-or
-
-```shell
-npm install --save @react-keycloak-refork/web
-```
-
-or as a `UMD` package through `unpkg`
-
-See `@react-keycloak-refork/web` package [README](https://github.com/react-keycloak/react-keycloak/blob/master/packages/web/README.md) for complete documentation.
-
-### SSR
-
-React Keycloak for SSR frameworks requires:
-
-- React **16.0** or later
-- SSR Framework:
-  - NextJS **9** or later
-  - Razzle **3** or later
-- `keycloak-js` **26.0.0** or later
-
-```shell
-yarn add @react-keycloak-refork/ssr
-```
-
-or
-
-```shell
-npm install --save @react-keycloak-refork/ssr
-```
-
-See `@react-keycloak-refork/ssr` package [README](https://github.com/react-keycloak/react-keycloak/blob/master/packages/ssr/README.md) for complete documentation.
-
-### React Native
-
-React Keycloak for React Native requires React Native **61.0** or later
-
-To install run
-
-```shell
-yarn add @react-keycloak-refork/native
-```
-
-or
-
-```shell
-npm install --save @react-keycloak-refork/native
-```
-
-See `@react-keycloak-refork/native` package [README](https://github.com/react-keycloak/react-native-keycloak/blob/master/README.md) for complete documentation.
-
-## Support
-
-| version | keycloak-js version | notes  |
-| ------- | ------------------- | ------ |
-| v6.0.0+ | 26.0.0+             | (fork) |
-| v4.0.3+ | 26.0.0+             | (fork) |
-| v4.0.1+ | 17.0.0+             | (fork) |
-| v2.0.0+ | 9.0.2+              |
-| v1.x    | >=8.0.2 <9.0.2      |
-
-## Examples
-
-See [`@react-keycloak-refork/react-keycloak-examples`](https://github.com/react-keycloak/react-keycloak-examples) repository for various demo implementing this library main features.
-
-## Alternatives
-
-If you need to connect using a more generic OIDC client instead of `keycloak.js`, consider using one of the following libraries:
-
-- [bjerkio/oidc-react](https://github.com/bjerkio/oidc-react)
-- [thchia/react-oidc](https://github.com/thchia/react-oidc)
-- [@axa-fr/react-oidc](https://github.com/AxaGuilDEv/react-oidc)
-
-## Migration Notice
-
-⚠️ **This project is no longer maintained**. For new projects, we strongly recommend using [NextAuth.js](https://next-auth.js.org/) instead, which provides:
-
-- ✅ Active maintenance and security updates
-- ✅ Support for 50+ OAuth providers including Keycloak
-- ✅ Better TypeScript support
-- ✅ Modern React patterns and hooks
-- ✅ Comprehensive documentation and examples
-- ✅ Active community and support
-
-### Migrating to NextAuth.js
-
-To migrate from this library to NextAuth.js with Keycloak:
-
-1. Install NextAuth.js: `npm install next-auth`
-2. Configure Keycloak as a provider in your NextAuth configuration
-3. Replace `useKeycloak()` hooks with NextAuth's `useSession()` and `signIn()`/`signOut()` functions
-4. Update your authentication logic to use NextAuth's session management
-
-See the [NextAuth.js documentation](https://next-auth.js.org/configuration/providers/keycloak) for detailed migration instructions.
-
-## Contributing
-
-See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
-
-## License
-
-MIT
+![React Keycloak](/art/react-keycloak-logo.png?raw=true 'React Keycloak Logo')
+
+# React Keycloak (Keycloak >=v26 Fork) <!-- omit in toc -->
+
+> React bindings for [Keycloak](https://www.keycloak.org/). Fork of https://github.com/react-keycloak/react-keycloak.git with updated packages for keycloak >=26 support.
+
+⚠️ **IMPORTANT NOTICE**: This fork has been updated to support Keycloak 26, but it is **NOT MAINTAINED**. We strongly recommend migrating to [NextAuth.js](https://next-auth.js.org/) for new projects, as it provides better maintenance, security updates, and broader OAuth provider support.
+
+[![NPM (scoped)](https://img.shields.io/npm/v/@react-keycloak-fork/core?label=npm%20%7C%20core)](https://www.npmjs.com/package/@react-keycloak-fork/core)
+[![NPM (scoped)](https://img.shields.io/npm/v/@react-keycloak-fork/web?label=npm%20%7C%20web)](https://www.npmjs.com/package/@react-keycloak-fork/web)
+[![NPM (scoped)](https://img.shields.io/npm/v/@react-keycloak-fork/ssr?label=npm%20%7C%20ssr)](https://www.npmjs.com/package/@react-keycloak-fork/ssr)
+[![NPM (scoped)](https://img.shields.io/npm/v/@react-keycloak-fork/native?label=npm%20%7C%20native)](https://www.npmjs.com/package/@react-keycloak-fork/native)
+
+[![License](https://img.shields.io/github/license/react-keycloak/react-keycloak.svg)](https://github.com/react-keycloak/react-keycloak-fork/blob/master/LICENSE.md)
+[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
+[![GitHub contributors](https://img.shields.io/github/contributors/react-keycloak/react-keycloak)](https://github.com/react-keycloak/react-keycloak-fork/graphs/contributors)
+[![Github Issues](https://img.shields.io/github/issues/react-keycloak/react-keycloak.svg)](https://github.com/react-keycloak/react-keycloak/issues) ![npm](https://img.shields.io/npm/dm/@react-keycloak-fork/core)
+
+[![Gitter](https://img.shields.io/gitter/room/react-keycloak/community)](https://gitter.im/react-keycloak/community)
+
+---
+
+## Table of Contents <!-- omit in toc -->
+
+- [Integrations](#integrations)
+  - [React](#react)
+  - [SSR](#ssr)
+  - [React Native](#react-native)
+- [Support](#support)
+- [Examples](#examples)
+- [Alternatives](#alternatives)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
+
+## Integrations
+
+### React
+
+React Keycloak for Web requires:
+
+- React **19.0** or later
+- `keycloak-js` **26.0.0** or later
+
+```shell
+yarn add @react-keycloak-fork/web
+```
+
+or
+
+```shell
+npm install --save @react-keycloak-fork/web
+```
+
+or as a `UMD` package through `unpkg`
+
+See `@react-keycloak-fork/web` package [README](https://github.com/react-keycloak/react-keycloak/blob/master/packages/web/README.md) for complete documentation.
+
+### SSR
+
+React Keycloak for SSR frameworks requires:
+
+- React **19.0** or later
+- SSR Framework:
+  - NextJS **9** or later
+  - Razzle **3** or later
+- `keycloak-js` **26.0.0** or later
+
+```shell
+yarn add @react-keycloak-fork/ssr
+```
+
+or
+
+```shell
+npm install --save @react-keycloak-fork/ssr
+```
+
+See `@react-keycloak-fork/ssr` package [README](https://github.com/react-keycloak/react-keycloak/blob/master/packages/ssr/README.md) for complete documentation.
+
+### React Native
+
+React Keycloak for React Native requires React Native **61.0** or later
+
+To install run
+
+```shell
+yarn add @react-keycloak-fork/native
+```
+
+or
+
+```shell
+npm install --save @react-keycloak-fork/native
+```
+
+See `@react-keycloak-fork/native` package [README](https://github.com/react-keycloak/react-native-keycloak/blob/master/README.md) for complete documentation.
+
+## Support
+
+| version | keycloak-js version | notes  |
+| ------- | ------------------- | ------ |
+| v4.0.3+ | 26.0.0+             | (fork) |
+| v4.0.1+ | 17.0.0+             | (fork) |
+| v2.0.0+ | 9.0.2+              |
+| v1.x    | >=8.0.2 <9.0.2      |
+
+## Examples
+
+See [`@react-keycloak-fork/react-keycloak-examples`](https://github.com/react-keycloak/react-keycloak-examples) repository for various demo implementing this library main features.
+
+## Alternatives
+
+If you need to connect using a more generic OIDC client instead of `keycloak.js`, consider using one of the following libraries:
+
+- [bjerkio/oidc-react](https://github.com/bjerkio/oidc-react)
+- [thchia/react-oidc](https://github.com/thchia/react-oidc)
+- [@axa-fr/react-oidc](https://github.com/AxaGuilDEv/react-oidc)
+
+## Migration Notice
+
+⚠️ **This project is no longer maintained**. For new projects, we strongly recommend using [NextAuth.js](https://next-auth.js.org/) instead, which provides:
+
+- ✅ Active maintenance and security updates
+- ✅ Support for 50+ OAuth providers including Keycloak
+- ✅ Better TypeScript support
+- ✅ Modern React patterns and hooks
+- ✅ Comprehensive documentation and examples
+- ✅ Active community and support
+
+### Migrating to NextAuth.js
+
+To migrate from this library to NextAuth.js with Keycloak:
+
+1. Install NextAuth.js: `npm install next-auth`
+2. Configure Keycloak as a provider in your NextAuth configuration
+3. Replace `useKeycloak()` hooks with NextAuth's `useSession()` and `signIn()`/`signOut()` functions
+4. Update your authentication logic to use NextAuth's session management
+
+See the [NextAuth.js documentation](https://next-auth.js.org/configuration/providers/keycloak) for detailed migration instructions.
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## License
+
+MIT

package/lib/context.d.ts

@@ -1,24 +1,23 @@
-/// <reference types="react" />
-import { AuthClient } from './types';
-/**
- * Auth Context props
- */
-export type IAuthContextProps<T extends AuthClient> = {
-    /**
-     * The single AuthClient of your application.
-     */
-    authClient?: T;
-    /**
-     * Boolean indicating whenever the AuthClient has been initialized by AuthProvider
-     */
-    initialized: boolean;
-};
-/**
- * Create a React context containing an AuthClient instance.
- *
- * @param {IAuthContextProps} initialContext initial context value.
- *
- * @returns {React.Context} the ReactKeycloak context.
- */
-export declare function createAuthContext<T extends AuthClient>(initialContext?: Partial<IAuthContextProps<T>>): React.Context<IAuthContextProps<T>>;
-export default createAuthContext;
+import { AuthClient } from './types';
+/**
+ * Auth Context props
+ */
+export type IAuthContextProps<T extends AuthClient> = {
+    /**
+     * The single AuthClient of your application.
+     */
+    authClient?: T;
+    /**
+     * Boolean indicating whenever the AuthClient has been initialized by AuthProvider
+     */
+    initialized: boolean;
+};
+/**
+ * Create a React context containing an AuthClient instance.
+ *
+ * @param {IAuthContextProps} initialContext initial context value.
+ *
+ * @returns {React.Context} the ReactKeycloak context.
+ */
+export declare function createAuthContext<T extends AuthClient>(initialContext?: Partial<IAuthContextProps<T>>): React.Context<IAuthContextProps<T>>;
+export default createAuthContext;

package/lib/context.js

@@ -1,24 +1,24 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-import { createContext } from 'react';
-/**
- * Create a React context containing an AuthClient instance.
- *
- * @param {IAuthContextProps} initialContext initial context value.
- *
- * @returns {React.Context} the ReactKeycloak context.
- */
-export function createAuthContext(initialContext) {
-    return createContext(__assign({ initialized: false }, initialContext));
-}
-export default createAuthContext;
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { createContext } from 'react';
+/**
+ * Create a React context containing an AuthClient instance.
+ *
+ * @param {IAuthContextProps} initialContext initial context value.
+ *
+ * @returns {React.Context} the ReactKeycloak context.
+ */
+export function createAuthContext(initialContext) {
+    return createContext(__assign({ initialized: false }, initialContext));
+}
+export default createAuthContext;
 //# sourceMappingURL=context.js.map

package/lib/index.d.ts

@@ -1,3 +1,3 @@
-export * from './context';
-export * from './provider';
-export * from './types';
+export * from './context';
+export * from './provider';
+export * from './types';

package/lib/index.js

@@ -1,5 +1,5 @@
-/* istanbul ignore file */
-export * from './context';
-export * from './provider';
-export * from './types';
+/* istanbul ignore file */
+export * from './context';
+export * from './provider';
+export * from './types';
 //# sourceMappingURL=index.js.map