@elementor/editor-current-user 3.32.0-38 → 3.32.0-40

package/dist/index.d.mts

@@ -1,5 +1,3 @@
-import { QueryClient } from '@elementor/query';
-
 declare const useSuppressedMessage: (messageKey: string) => readonly [boolean, () => void];
 
 declare const useCurrentUserCapabilities: () => {
@@ -7,13 +5,18 @@ declare const useCurrentUserCapabilities: () => {
     capabilities: string[] | undefined;
 };
 
-declare const getCurrentUser: () => Promise<{
+type UserModel = {
+    suppressedMessages: string[];
+    capabilities: string[];
+};
+
+declare const getCurrentUser: () => UserModel | undefined;
+
+declare function ensureUser(): Promise<{
     capabilities: string[];
     suppressedMessages: string[];
 }>;
 
-declare function ensureCurrentUser({ queryClient }: {
-    queryClient: QueryClient;
-}): unknown;
+declare function onSetUser(callback: (user: UserModel | null) => void): () => void;
 
-export { ensureCurrentUser, getCurrentUser, useCurrentUserCapabilities, useSuppressedMessage };
+export { ensureUser, getCurrentUser, onSetUser, useCurrentUserCapabilities, useSuppressedMessage };

package/dist/index.d.ts

@@ -1,5 +1,3 @@
-import { QueryClient } from '@elementor/query';
-
 declare const useSuppressedMessage: (messageKey: string) => readonly [boolean, () => void];
 
 declare const useCurrentUserCapabilities: () => {
@@ -7,13 +5,18 @@ declare const useCurrentUserCapabilities: () => {
     capabilities: string[] | undefined;
 };
 
-declare const getCurrentUser: () => Promise<{
+type UserModel = {
+    suppressedMessages: string[];
+    capabilities: string[];
+};
+
+declare const getCurrentUser: () => UserModel | undefined;
+
+declare function ensureUser(): Promise<{
     capabilities: string[];
     suppressedMessages: string[];
 }>;
 
-declare function ensureCurrentUser({ queryClient }: {
-    queryClient: QueryClient;
-}): unknown;
+declare function onSetUser(callback: (user: UserModel | null) => void): () => void;
 
-export { ensureCurrentUser, getCurrentUser, useCurrentUserCapabilities, useSuppressedMessage };
+export { ensureUser, getCurrentUser, onSetUser, useCurrentUserCapabilities, useSuppressedMessage };

package/dist/index.js

@@ -20,8 +20,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  ensureCurrentUser: () => ensureCurrentUser,
+  ensureUser: () => ensureUser,
   getCurrentUser: () => getCurrentUser,
+  onSetUser: () => onSetUser,
   useCurrentUserCapabilities: () => useCurrentUserCapabilities,
   useSuppressedMessage: () => useSuppressedMessage
 });
@@ -44,16 +45,11 @@ var apiClient = {
   })
 };
 
-// src/get-current-user.ts
-var getCurrentUser = () => {
-  return apiClient.get();
-};
-
 // src/use-current-user.ts
 var EDITOR_CURRENT_USER_QUERY_KEY = "editor-current-user";
 var useCurrentUser = () => (0, import_query.useQuery)({
   queryKey: [EDITOR_CURRENT_USER_QUERY_KEY],
-  queryFn: getCurrentUser
+  queryFn: apiClient.get
 });
 
 // src/use-update-current-user.ts
@@ -90,26 +86,47 @@ var useCurrentUserCapabilities = () => {
   return { canUser, capabilities: data?.capabilities };
 };
 
+// src/get-current-user.ts
+var import_query3 = require("@elementor/query");
+var getCurrentUser = () => {
+  const queryClient = (0, import_query3.getQueryClient)();
+  return queryClient.getQueryData([EDITOR_CURRENT_USER_QUERY_KEY]);
+};
+
 // src/ensure-current-user.ts
+var import_query4 = require("@elementor/query");
+async function ensureUser() {
+  const queryClient = (0, import_query4.getQueryClient)();
+  return queryClient.ensureQueryData({
+    queryKey: [EDITOR_CURRENT_USER_QUERY_KEY],
+    queryFn: apiClient.get,
+    retry: false
+  });
+}
+
+// src/on-set-user.ts
 var import_editor_v1_adapters = require("@elementor/editor-v1-adapters");
-function ensureCurrentUser({ queryClient }) {
-  (0, import_editor_v1_adapters.registerDataHook)("after", "editor/documents/attach-preview", async () => {
-    try {
-      await queryClient.ensureQueryData({
-        queryKey: [EDITOR_CURRENT_USER_QUERY_KEY],
-        queryFn: getCurrentUser,
-        retry: false
-      });
-    } catch {
-      queryClient.setQueryData([EDITOR_CURRENT_USER_QUERY_KEY], null);
-    }
+var import_query5 = require("@elementor/query");
+function onSetUser(callback) {
+  let unsubscribeQuery;
+  const unsubscribeListener = (0, import_editor_v1_adapters.__privateListenTo)((0, import_editor_v1_adapters.v1ReadyEvent)(), () => {
+    const queryClient = (0, import_query5.getQueryClient)();
+    unsubscribeQuery = queryClient.getQueryCache().subscribe((event) => {
+      if (event.query.queryKey.includes(EDITOR_CURRENT_USER_QUERY_KEY)) {
+        callback(event.query.state.data);
+      }
+    });
   });
-  return queryClient.getQueryData([EDITOR_CURRENT_USER_QUERY_KEY]);
+  return () => {
+    unsubscribeQuery();
+    unsubscribeListener();
+  };
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  ensureCurrentUser,
+  ensureUser,
   getCurrentUser,
+  onSetUser,
   useCurrentUserCapabilities,
   useSuppressedMessage
 });

package/dist/index.mjs

@@ -15,16 +15,11 @@ var apiClient = {
   })
 };
 
-// src/get-current-user.ts
-var getCurrentUser = () => {
-  return apiClient.get();
-};
-
 // src/use-current-user.ts
 var EDITOR_CURRENT_USER_QUERY_KEY = "editor-current-user";
 var useCurrentUser = () => useQuery({
   queryKey: [EDITOR_CURRENT_USER_QUERY_KEY],
-  queryFn: getCurrentUser
+  queryFn: apiClient.get
 });
 
 // src/use-update-current-user.ts
@@ -61,25 +56,46 @@ var useCurrentUserCapabilities = () => {
   return { canUser, capabilities: data?.capabilities };
 };
 
+// src/get-current-user.ts
+import { getQueryClient } from "@elementor/query";
+var getCurrentUser = () => {
+  const queryClient = getQueryClient();
+  return queryClient.getQueryData([EDITOR_CURRENT_USER_QUERY_KEY]);
+};
+
 // src/ensure-current-user.ts
-import { registerDataHook } from "@elementor/editor-v1-adapters";
-function ensureCurrentUser({ queryClient }) {
-  registerDataHook("after", "editor/documents/attach-preview", async () => {
-    try {
-      await queryClient.ensureQueryData({
-        queryKey: [EDITOR_CURRENT_USER_QUERY_KEY],
-        queryFn: getCurrentUser,
-        retry: false
-      });
-    } catch {
-      queryClient.setQueryData([EDITOR_CURRENT_USER_QUERY_KEY], null);
-    }
+import { getQueryClient as getQueryClient2 } from "@elementor/query";
+async function ensureUser() {
+  const queryClient = getQueryClient2();
+  return queryClient.ensureQueryData({
+    queryKey: [EDITOR_CURRENT_USER_QUERY_KEY],
+    queryFn: apiClient.get,
+    retry: false
   });
-  return queryClient.getQueryData([EDITOR_CURRENT_USER_QUERY_KEY]);
+}
+
+// src/on-set-user.ts
+import { __privateListenTo as listenTo, v1ReadyEvent } from "@elementor/editor-v1-adapters";
+import { getQueryClient as getQueryClient3 } from "@elementor/query";
+function onSetUser(callback) {
+  let unsubscribeQuery;
+  const unsubscribeListener = listenTo(v1ReadyEvent(), () => {
+    const queryClient = getQueryClient3();
+    unsubscribeQuery = queryClient.getQueryCache().subscribe((event) => {
+      if (event.query.queryKey.includes(EDITOR_CURRENT_USER_QUERY_KEY)) {
+        callback(event.query.state.data);
+      }
+    });
+  });
+  return () => {
+    unsubscribeQuery();
+    unsubscribeListener();
+  };
 }
 export {
-  ensureCurrentUser,
+  ensureUser,
   getCurrentUser,
+  onSetUser,
   useCurrentUserCapabilities,
   useSuppressedMessage
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elementor/editor-current-user",
   "description": "Elementor Editor Current User",
-  "version": "3.32.0-38",
+  "version": "3.32.0-40",
   "private": false,
   "author": "Elementor Team",
   "homepage": "https://elementor.com/",
@@ -36,9 +36,9 @@
     "react": "^18.3.1"
   },
   "dependencies": {
-    "@elementor/editor-v1-adapters": "3.32.0-38",
-    "@elementor/http-client": "3.32.0-38",
-    "@elementor/query": "3.32.0-38"
+    "@elementor/editor-v1-adapters": "3.32.0-40",
+    "@elementor/http-client": "3.32.0-40",
+    "@elementor/query": "3.32.0-40"
   },
   "devDependencies": {
     "tsup": "^8.3.5"

package/src/api.ts

@@ -8,7 +8,7 @@ type GetUserPayload = {
 	params?: { context?: 'edit' };
 };
 
-type UserModel = {
+export type UserModel = {
 	suppressedMessages: string[];
 	capabilities: string[];
 };

package/src/ensure-current-user.ts

@@ -1,21 +1,14 @@
-import { registerDataHook } from '@elementor/editor-v1-adapters';
-import { type QueryClient } from '@elementor/query';
+import { getQueryClient } from '@elementor/query';
 
-import { getCurrentUser } from './get-current-user';
+import { apiClient } from './api';
 import { EDITOR_CURRENT_USER_QUERY_KEY } from './use-current-user';
 
-export function ensureCurrentUser( { queryClient }: { queryClient: QueryClient } ) {
-	registerDataHook( 'after', 'editor/documents/attach-preview', async () => {
-		try {
-			await queryClient.ensureQueryData( {
-				queryKey: [ EDITOR_CURRENT_USER_QUERY_KEY ],
-				queryFn: getCurrentUser,
-				retry: false,
-			} );
-		} catch {
-			queryClient.setQueryData( [ EDITOR_CURRENT_USER_QUERY_KEY ], null );
-		}
-	} );
+export async function ensureUser() {
+	const queryClient = getQueryClient();
 
-	return queryClient.getQueryData( [ EDITOR_CURRENT_USER_QUERY_KEY ] );
+	return queryClient.ensureQueryData( {
+		queryKey: [ EDITOR_CURRENT_USER_QUERY_KEY ],
+		queryFn: apiClient.get,
+		retry: false,
+	} );
 }

package/src/get-current-user.ts

@@ -1,5 +1,10 @@
-import { apiClient } from './api';
+import { getQueryClient } from '@elementor/query';
+
+import { type UserModel } from './api';
+import { EDITOR_CURRENT_USER_QUERY_KEY } from './use-current-user';
 
 export const getCurrentUser = () => {
-	return apiClient.get();
+	const queryClient = getQueryClient();
+
+	return queryClient.getQueryData< UserModel >( [ EDITOR_CURRENT_USER_QUERY_KEY ] );
 };

package/src/index.ts

@@ -1,4 +1,5 @@
 export { useSuppressedMessage } from './use-suppressed-message';
 export { useCurrentUserCapabilities } from './use-current-user-capabilities';
 export { getCurrentUser } from './get-current-user';
-export { ensureCurrentUser } from './ensure-current-user';
+export { ensureUser } from './ensure-current-user';
+export { onSetUser } from './on-set-user';

package/src/on-set-user.ts

@@ -0,0 +1,24 @@
+import { __privateListenTo as listenTo, v1ReadyEvent } from '@elementor/editor-v1-adapters';
+import { getQueryClient } from '@elementor/query';
+
+import { type UserModel } from './api';
+import { EDITOR_CURRENT_USER_QUERY_KEY } from './use-current-user';
+
+export function onSetUser( callback: ( user: UserModel | null ) => void ): () => void {
+	let unsubscribeQuery: () => void;
+
+	const unsubscribeListener = listenTo( v1ReadyEvent(), () => {
+		const queryClient = getQueryClient();
+
+		unsubscribeQuery = queryClient.getQueryCache().subscribe( ( event ) => {
+			if ( event.query.queryKey.includes( EDITOR_CURRENT_USER_QUERY_KEY ) ) {
+				callback( event.query.state.data as UserModel | null );
+			}
+		} );
+	} );
+
+	return () => {
+		unsubscribeQuery();
+		unsubscribeListener();
+	};
+}

package/src/use-current-user.ts

@@ -1,11 +1,11 @@
 import { useQuery } from '@elementor/query';
 
-import { getCurrentUser } from './get-current-user';
+import { apiClient } from './api';
 
 export const EDITOR_CURRENT_USER_QUERY_KEY = 'editor-current-user';
 
 export const useCurrentUser = () =>
 	useQuery( {
 		queryKey: [ EDITOR_CURRENT_USER_QUERY_KEY ],
-		queryFn: getCurrentUser,
+		queryFn: apiClient.get,
 	} );

package/src/__tests__/ensure-current-user.test.tsx

@@ -1,36 +0,0 @@
-import { registerDataHook } from '@elementor/editor-v1-adapters';
-import { type QueryClient } from '@elementor/query';
-
-import { ensureCurrentUser } from '../ensure-current-user';
-
-jest.mock( '@elementor/editor-v1-adapters', () => ( {
-	...jest.requireActual( '@elementor/editor-v1-adapters' ),
-	registerDataHook: jest.fn(),
-} ) );
-
-describe( 'ensureCurrentUser', () => {
-	it( 'should not fail the attach preview command is user fetch failed', async () => {
-		// Arrange.
-		const queryClient = {
-			ensureQueryData: jest.fn().mockRejectedValue( new Error( 'Failed to fetch current user' ) ),
-			setQueryData: jest.fn(),
-			getQueryData: jest.fn().mockReturnValue( null ),
-		} as unknown as QueryClient;
-
-		jest.mocked( registerDataHook ).mockImplementation( ( _hook, _command, callback ) => {
-			return callback( {} ) as never;
-		} );
-
-		// Act.
-		const result = await ensureCurrentUser( { queryClient } );
-
-		// Assert.
-		expect( queryClient.ensureQueryData ).toHaveBeenCalledWith( {
-			queryKey: [ 'editor-current-user' ],
-			queryFn: expect.any( Function ),
-			retry: false,
-		} );
-
-		expect( result ).toBeNull();
-	} );
-} );