fix: provide better error when usePuck used inappropriately

measuredco · Dec 16, 2024 · 9991c07 · 9991c07
1 parent 8680db3
commit 9991c07
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/packages/core/components/Puck/context.tsx b/packages/core/components/Puck/context.tsx
@@ -86,7 +86,7 @@ export type AppContext<
   refreshPermissions: RefreshPermissions<UserConfig>;
 };
 
-const defaultContext: AppContext = {
+export const defaultContext: AppContext = {
   state: defaultAppState,
   dispatch: () => null,
   config: { components: {} },

diff --git a/packages/core/lib/use-puck.ts b/packages/core/lib/use-puck.ts
@@ -1,4 +1,4 @@
-import { useAppContext } from "../components/Puck/context";
+import { defaultContext, useAppContext } from "../components/Puck/context";
 import { Config, UserGenerics } from "../types";
 
 export const usePuck = <UserConfig extends Config = Config>() => {
@@ -12,6 +12,12 @@ export const usePuck = <UserConfig extends Config = Config>() => {
     refreshPermissions,
   } = useAppContext<UserConfig>();
 
+  if (dispatch === defaultContext.dispatch) {
+    throw new Error(
+      "usePuck was used outside of the <Puck> component. The usePuck hook must be rendered within the <Puck> context as children, overrides or plugins as described in https://puckeditor.com/docs/api-reference/functions/use-puck."
+    );
+  }
+
   return {
     appState,
     config,