@elementor/editor-current-user 4.3.0-beta2 → 4.3.0

package/dist/index.d.mts

@@ -12,18 +12,23 @@ declare const useCurrentUserCapabilities: () => {
 type User = {
     suppressedMessages: string[];
     capabilities: string[];
+    restrictions: string[];
 };
 
 type UserModel = {
     suppressedMessages: string[];
     capabilities: string[];
+    restrictions: string[];
 };
 
 declare const getCurrentUser: () => UserModel | undefined;
 
+declare const isContentOnlyUser: () => boolean;
+
 declare function ensureUser(): Promise<{
     capabilities: string[];
     suppressedMessages: string[];
+    restrictions: string[];
 }>;
 
 declare function onSetUser(callback: (user: UserModel | null) => void): () => void;
@@ -31,8 +36,17 @@ declare function onSetUser(callback: (user: UserModel | null) => void): () => vo
 declare const useCurrentUser: () => _tanstack_react_query.UseQueryResult<{
     capabilities: string[];
     suppressedMessages: string[];
+    restrictions: string[];
 }, Error>;
 
 declare const useUpdateCurrentUser: () => _tanstack_react_query.UseMutationResult<axios.AxiosResponse<Partial<UserModel>, any, {}>, Error, Partial<User>, unknown>;
 
-export { ensureUser, getCurrentUser, onSetUser, useCurrentUser, useCurrentUserCapabilities, useSuppressedMessage, useUpdateCurrentUser };
+declare const DESIGN_RESTRICTION = "design";
+declare const useUserRestrictions: () => {
+    isRestricted: (restriction: string) => boolean;
+    restrictions: string[] | undefined;
+};
+
+declare const useHasContentOnlyAccess: () => boolean;
+
+export { DESIGN_RESTRICTION, ensureUser, getCurrentUser, isContentOnlyUser, onSetUser, useCurrentUser, useCurrentUserCapabilities, useHasContentOnlyAccess, useSuppressedMessage, useUpdateCurrentUser, useUserRestrictions };

package/dist/index.d.ts

@@ -12,18 +12,23 @@ declare const useCurrentUserCapabilities: () => {
 type User = {
     suppressedMessages: string[];
     capabilities: string[];
+    restrictions: string[];
 };
 
 type UserModel = {
     suppressedMessages: string[];
     capabilities: string[];
+    restrictions: string[];
 };
 
 declare const getCurrentUser: () => UserModel | undefined;
 
+declare const isContentOnlyUser: () => boolean;
+
 declare function ensureUser(): Promise<{
     capabilities: string[];
     suppressedMessages: string[];
+    restrictions: string[];
 }>;
 
 declare function onSetUser(callback: (user: UserModel | null) => void): () => void;
@@ -31,8 +36,17 @@ declare function onSetUser(callback: (user: UserModel | null) => void): () => vo
 declare const useCurrentUser: () => _tanstack_react_query.UseQueryResult<{
     capabilities: string[];
     suppressedMessages: string[];
+    restrictions: string[];
 }, Error>;
 
 declare const useUpdateCurrentUser: () => _tanstack_react_query.UseMutationResult<axios.AxiosResponse<Partial<UserModel>, any, {}>, Error, Partial<User>, unknown>;
 
-export { ensureUser, getCurrentUser, onSetUser, useCurrentUser, useCurrentUserCapabilities, useSuppressedMessage, useUpdateCurrentUser };
+declare const DESIGN_RESTRICTION = "design";
+declare const useUserRestrictions: () => {
+    isRestricted: (restriction: string) => boolean;
+    restrictions: string[] | undefined;
+};
+
+declare const useHasContentOnlyAccess: () => boolean;
+
+export { DESIGN_RESTRICTION, ensureUser, getCurrentUser, isContentOnlyUser, onSetUser, useCurrentUser, useCurrentUserCapabilities, useHasContentOnlyAccess, useSuppressedMessage, useUpdateCurrentUser, useUserRestrictions };

package/dist/index.js

@@ -20,13 +20,17 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  DESIGN_RESTRICTION: () => DESIGN_RESTRICTION,
   ensureUser: () => ensureUser,
   getCurrentUser: () => getCurrentUser,
+  isContentOnlyUser: () => isContentOnlyUser,
   onSetUser: () => onSetUser,
   useCurrentUser: () => useCurrentUser,
   useCurrentUserCapabilities: () => useCurrentUserCapabilities,
+  useHasContentOnlyAccess: () => useHasContentOnlyAccess,
   useSuppressedMessage: () => useSuppressedMessage,
-  useUpdateCurrentUser: () => useUpdateCurrentUser
+  useUpdateCurrentUser: () => useUpdateCurrentUser,
+  useUserRestrictions: () => useUserRestrictions
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -39,8 +43,8 @@ var RESOURCE_URL = "elementor/v1/user-data/current-user";
 var getUserPayload = { params: { context: "edit" } };
 var apiClient = {
   get: () => (0, import_http_client.httpService)().get(RESOURCE_URL, getUserPayload).then((res) => {
-    const { capabilities = [], suppressedMessages = [] } = res.data;
-    return { capabilities, suppressedMessages };
+    const { capabilities = [], suppressedMessages = [], restrictions = [] } = res.data;
+    return { capabilities, suppressedMessages, restrictions };
   }),
   update: (data) => (0, import_http_client.httpService)().patch(RESOURCE_URL, {
     suppressedMessages: data.suppressedMessages
@@ -97,6 +101,22 @@ var getCurrentUser = () => {
   return queryClient.getQueryData([EDITOR_CURRENT_USER_QUERY_KEY]);
 };
 
+// src/use-user-restrictions.ts
+var DESIGN_RESTRICTION = "design";
+var useUserRestrictions = () => {
+  const { data } = useCurrentUser();
+  const isRestricted = (restriction) => Boolean(data?.restrictions?.includes(restriction));
+  return {
+    isRestricted,
+    restrictions: data?.restrictions
+  };
+};
+
+// src/is-content-only-user.ts
+var isContentOnlyUser = () => {
+  return Boolean(getCurrentUser()?.restrictions?.includes(DESIGN_RESTRICTION));
+};
+
 // src/ensure-current-user.ts
 var import_query4 = require("@elementor/query");
 async function ensureUser() {
@@ -126,14 +146,21 @@ function onSetUser(callback) {
     unsubscribeListener();
   };
 }
+
+// src/use-has-content-only-access.ts
+var useHasContentOnlyAccess = () => useUserRestrictions().isRestricted(DESIGN_RESTRICTION);
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  DESIGN_RESTRICTION,
   ensureUser,
   getCurrentUser,
+  isContentOnlyUser,
   onSetUser,
   useCurrentUser,
   useCurrentUserCapabilities,
+  useHasContentOnlyAccess,
   useSuppressedMessage,
-  useUpdateCurrentUser
+  useUpdateCurrentUser,
+  useUserRestrictions
 });
 //# sourceMappingURL=index.js.map

package/dist/index.mjs

@@ -7,8 +7,8 @@ var RESOURCE_URL = "elementor/v1/user-data/current-user";
 var getUserPayload = { params: { context: "edit" } };
 var apiClient = {
   get: () => httpService().get(RESOURCE_URL, getUserPayload).then((res) => {
-    const { capabilities = [], suppressedMessages = [] } = res.data;
-    return { capabilities, suppressedMessages };
+    const { capabilities = [], suppressedMessages = [], restrictions = [] } = res.data;
+    return { capabilities, suppressedMessages, restrictions };
   }),
   update: (data) => httpService().patch(RESOURCE_URL, {
     suppressedMessages: data.suppressedMessages
@@ -65,6 +65,22 @@ var getCurrentUser = () => {
   return queryClient.getQueryData([EDITOR_CURRENT_USER_QUERY_KEY]);
 };
 
+// src/use-user-restrictions.ts
+var DESIGN_RESTRICTION = "design";
+var useUserRestrictions = () => {
+  const { data } = useCurrentUser();
+  const isRestricted = (restriction) => Boolean(data?.restrictions?.includes(restriction));
+  return {
+    isRestricted,
+    restrictions: data?.restrictions
+  };
+};
+
+// src/is-content-only-user.ts
+var isContentOnlyUser = () => {
+  return Boolean(getCurrentUser()?.restrictions?.includes(DESIGN_RESTRICTION));
+};
+
 // src/ensure-current-user.ts
 import { getQueryClient as getQueryClient2 } from "@elementor/query";
 async function ensureUser() {
@@ -94,13 +110,20 @@ function onSetUser(callback) {
     unsubscribeListener();
   };
 }
+
+// src/use-has-content-only-access.ts
+var useHasContentOnlyAccess = () => useUserRestrictions().isRestricted(DESIGN_RESTRICTION);
 export {
+  DESIGN_RESTRICTION,
   ensureUser,
   getCurrentUser,
+  isContentOnlyUser,
   onSetUser,
   useCurrentUser,
   useCurrentUserCapabilities,
+  useHasContentOnlyAccess,
   useSuppressedMessage,
-  useUpdateCurrentUser
+  useUpdateCurrentUser,
+  useUserRestrictions
 };
 //# sourceMappingURL=index.mjs.map

package/package.json

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

package/src/__tests__/is-content-only-user.test.ts

@@ -0,0 +1,45 @@
+import { type UserModel } from '../api';
+import { getCurrentUser } from '../get-current-user';
+import { isContentOnlyUser } from '../is-content-only-user';
+import { DESIGN_RESTRICTION } from '../use-user-restrictions';
+
+jest.mock( '../get-current-user' );
+
+describe( 'isContentOnlyUser', () => {
+	it( 'should return true when the design restriction is present', () => {
+		// Arrange
+		jest.mocked( getCurrentUser ).mockReturnValue( {
+			restrictions: [ DESIGN_RESTRICTION ],
+		} as UserModel );
+
+		// Act
+		const result = isContentOnlyUser();
+
+		// Assert
+		expect( result ).toBe( true );
+	} );
+
+	it( 'should return false when the design restriction is absent', () => {
+		// Arrange
+		jest.mocked( getCurrentUser ).mockReturnValue( {
+			restrictions: [ 'json-upload' ],
+		} as UserModel );
+
+		// Act
+		const result = isContentOnlyUser();
+
+		// Assert
+		expect( result ).toBe( false );
+	} );
+
+	it( 'should return false when there is no cached user', () => {
+		// Arrange
+		jest.mocked( getCurrentUser ).mockReturnValue( undefined );
+
+		// Act
+		const result = isContentOnlyUser();
+
+		// Assert
+		expect( result ).toBe( false );
+	} );
+} );

package/src/__tests__/use-user-restrictions.test.ts

@@ -0,0 +1,77 @@
+import { type UseQueryResult } from '@elementor/query';
+import { renderHook } from '@testing-library/react';
+
+import { type User } from '../types';
+import { useCurrentUser } from '../use-current-user';
+import { useHasContentOnlyAccess } from '../use-has-content-only-access';
+import { DESIGN_RESTRICTION, useUserRestrictions } from '../use-user-restrictions';
+
+jest.mock( '../use-current-user' );
+
+const mockRestrictions = ( restrictions: string[] ) => {
+	jest.mocked( useCurrentUser ).mockReturnValue( {
+		data: { restrictions },
+	} as UseQueryResult< User, Error > );
+};
+
+describe( 'useUserRestrictions', () => {
+	it( 'should report the restrictions it was given', () => {
+		// Arrange
+		mockRestrictions( [ 'json-upload' ] );
+
+		// Act
+		const { result } = renderHook( () => useUserRestrictions() );
+
+		// Assert
+		expect( result.current.restrictions ).toEqual( [ 'json-upload' ] );
+		expect( result.current.isRestricted( 'json-upload' ) ).toBe( true );
+		expect( result.current.isRestricted( DESIGN_RESTRICTION ) ).toBe( false );
+	} );
+
+	it( 'should report nothing as restricted while the user data is unavailable', () => {
+		// Arrange
+		jest.mocked( useCurrentUser ).mockReturnValue( {} as UseQueryResult< User, Error > );
+
+		// Act
+		const { result } = renderHook( () => useUserRestrictions() );
+
+		// Assert
+		expect( result.current.restrictions ).toBeUndefined();
+		expect( result.current.isRestricted( DESIGN_RESTRICTION ) ).toBe( false );
+	} );
+} );
+
+describe( 'useHasContentOnlyAccess', () => {
+	it( 'should report content-only access when the design restriction is present', () => {
+		// Arrange
+		mockRestrictions( [ DESIGN_RESTRICTION ] );
+
+		// Act
+		const { result } = renderHook( () => useHasContentOnlyAccess() );
+
+		// Assert
+		expect( result.current ).toBe( true );
+	} );
+
+	it( 'should not report content-only access for unrelated restrictions', () => {
+		// Arrange
+		mockRestrictions( [ 'json-upload' ] );
+
+		// Act
+		const { result } = renderHook( () => useHasContentOnlyAccess() );
+
+		// Assert
+		expect( result.current ).toBe( false );
+	} );
+
+	it( 'should not report content-only access while the user data is unavailable', () => {
+		// Arrange
+		jest.mocked( useCurrentUser ).mockReturnValue( {} as UseQueryResult< User, Error > );
+
+		// Act
+		const { result } = renderHook( () => useHasContentOnlyAccess() );
+
+		// Assert
+		expect( result.current ).toBe( false );
+	} );
+} );

package/src/api.ts

@@ -11,6 +11,7 @@ type GetUserPayload = {
 export type UserModel = {
 	suppressedMessages: string[];
 	capabilities: string[];
+	restrictions: string[];
 };
 
 const getUserPayload: GetUserPayload = { params: { context: 'edit' } };
@@ -20,9 +21,9 @@ export const apiClient = {
 		httpService()
 			.get< UserModel >( RESOURCE_URL, getUserPayload )
 			.then( ( res ) => {
-				const { capabilities = [], suppressedMessages = [] } = res.data;
+				const { capabilities = [], suppressedMessages = [], restrictions = [] } = res.data;
 
-				return { capabilities, suppressedMessages };
+				return { capabilities, suppressedMessages, restrictions };
 			} ),
 	update: ( data: Partial< User > ) =>
 		httpService().patch< Partial< UserModel > >( RESOURCE_URL, {

package/src/index.ts

@@ -1,7 +1,10 @@
 export { useSuppressedMessage } from './use-suppressed-message';
 export { useCurrentUserCapabilities } from './use-current-user-capabilities';
 export { getCurrentUser } from './get-current-user';
+export { isContentOnlyUser } from './is-content-only-user';
 export { ensureUser } from './ensure-current-user';
 export { onSetUser } from './on-set-user';
 export { useCurrentUser } from './use-current-user';
 export { useUpdateCurrentUser } from './use-update-current-user';
+export { DESIGN_RESTRICTION, useUserRestrictions } from './use-user-restrictions';
+export { useHasContentOnlyAccess } from './use-has-content-only-access';

package/src/is-content-only-user.ts

@@ -0,0 +1,6 @@
+import { getCurrentUser } from './get-current-user';
+import { DESIGN_RESTRICTION } from './use-user-restrictions';
+
+export const isContentOnlyUser = () => {
+	return Boolean( getCurrentUser()?.restrictions?.includes( DESIGN_RESTRICTION ) );
+};

package/src/types.ts

@@ -1,4 +1,5 @@
 export type User = {
 	suppressedMessages: string[];
 	capabilities: string[];
+	restrictions: string[];
 };

package/src/use-has-content-only-access.ts

@@ -0,0 +1,3 @@
+import { DESIGN_RESTRICTION, useUserRestrictions } from './use-user-restrictions';
+
+export const useHasContentOnlyAccess = () => useUserRestrictions().isRestricted( DESIGN_RESTRICTION );

package/src/use-user-restrictions.ts

@@ -0,0 +1,14 @@
+import { useCurrentUser } from './use-current-user';
+
+export const DESIGN_RESTRICTION = 'design';
+
+export const useUserRestrictions = () => {
+	const { data } = useCurrentUser();
+
+	const isRestricted = ( restriction: string ) => Boolean( data?.restrictions?.includes( restriction ) );
+
+	return {
+		isRestricted,
+		restrictions: data?.restrictions,
+	};
+};