Avoid deprecating getKcContext #274

README.md

@@ -95,6 +95,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 ## Changelog highlights
 
+## 7.7
+
+-   Better storybook support, see [the starter project](https://github.com/keycloakify/keycloakify-starter).
+
 ## 7.0 🍾
 
 -   Account theme support 🚀

src/account/kcContext/getKcContext.ts

@@ -2,7 +2,9 @@ import type { DeepPartial } from "keycloakify/tools/DeepPartial";
 import type { ExtendKcContext } from "./getKcContextFromWindow";
 import { createGetKcContext } from "./createGetKcContext";
 
-/** @deprecated: Use createGetKcContext instead */
+/** NOTE: We now recommend using createGetKcContext instead of this function to make storybook integration easier
+ *  See: https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/account/kcContext.ts
+ */
 export function getKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
     mockPageId?: ExtendKcContext<KcContextExtension>["pageId"];
     mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];

src/login/kcContext/getKcContext.ts

@@ -2,7 +2,9 @@ import type { DeepPartial } from "keycloakify/tools/DeepPartial";
 import type { ExtendKcContext } from "./getKcContextFromWindow";
 import { createGetKcContext } from "./createGetKcContext";
 
-/** @deprecated: Use createGetKcContext instead */
+/** NOTE: We now recommend using createGetKcContext instead of this function to make storybook integration easier
+ *  See: https://github.com/keycloakify/keycloakify-starter/blob/main/src/keycloak-theme/account/kcContext.ts
+ */
 export function getKcContext<KcContextExtension extends { pageId: string } = never>(params?: {
     mockPageId?: ExtendKcContext<KcContextExtension>["pageId"];
     mockData?: readonly DeepPartial<ExtendKcContext<KcContextExtension>>[];