Use XP_REQUEST_MODE constant

enonic · Dec 11, 2024 · 108547c · 108547c
1 parent 23847a1
commit 108547c
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 21 deletions.
diff --git a/src/Common/Message.tsx b/src/Common/Message.tsx
@@ -6,6 +6,7 @@ import type {ReactNode} from 'react';
 
 import { ErrorComponent } from './ErrorComponent';
 import { Warning } from './Warning';
+import { XP_REQUEST_MODE } from '../constants';
 
 
 export const Message = ({
@@ -18,18 +19,18 @@ export const Message = ({
 }): JSX.Element | null => {
 
 	// Log, but don't render errors in live and preview mode.
-	if (mode === 'live' || mode === 'preview') {
+	if (mode === XP_REQUEST_MODE.LIVE || mode === XP_REQUEST_MODE.PREVIEW) {
 		console.error(children);
 		return null;
 	}
 
-	if (mode === 'inline') {
+	if (mode === XP_REQUEST_MODE.INLINE) {
 		return (
 			<Warning {...extraProps} children={children}/>
 		);
 	}
 
-	if (mode === 'edit') {
+	if (mode === XP_REQUEST_MODE.EDIT || mode === XP_REQUEST_MODE.ADMIN) {
 		return (
 			<ErrorComponent {...extraProps} children={children}/>
 		);

diff --git a/src/Common/TryCatch.tsx b/src/Common/TryCatch.tsx
@@ -6,6 +6,7 @@ import type {ReactNode} from 'react';
 
 import * as React from 'react';
 import { Message } from './Message';
+import { XP_REQUEST_MODE } from '../constants';
 
 export const TryCatch = ({
 	children,
@@ -22,7 +23,7 @@ export const TryCatch = ({
 				<h2>Error rendering component</h2>
 				<p>{e.message}</p>
 				{
-					mode === 'edit' && (
+					mode === XP_REQUEST_MODE.EDIT && (
 						<pre>{e.stack || ''}</pre>
 					)
 				}

diff --git a/src/ComponentRegistry/BaseComponent.tsx b/src/ComponentRegistry/BaseComponent.tsx
@@ -5,7 +5,10 @@ import type {RenderableComponent} from '../types';
 import { toStr } from '@enonic/js-utils/value/toStr';
 import * as React from 'react';
 
-import {RENDERABLE_COMPONENT_TYPE} from '../constants';
+import {
+	RENDERABLE_COMPONENT_TYPE,
+	XP_REQUEST_MODE,
+} from '../constants';
 import {ErrorComponent} from '../Common/ErrorComponent';
 import {Warning} from '../Common/Warning';
 import {BaseLayout} from './BaseLayout';
@@ -85,7 +88,7 @@ export function BaseComponent({
 				html,
 				mode
 			} = component;
-			if (mode === 'live') {
+			if (mode === XP_REQUEST_MODE.LIVE) {
 				return null;
 			}
 			return (
@@ -97,7 +100,7 @@ export function BaseComponent({
 				html,
 				mode
 			} = component;
-			if (mode === 'live') {
+			if (mode === XP_REQUEST_MODE.LIVE) {
 				return null;
 			}
 			return (

diff --git a/src/ComponentRegistry/BaseContentType.tsx b/src/ComponentRegistry/BaseContentType.tsx
@@ -5,6 +5,7 @@ import type {
 
 import * as React from 'react';
 import { Message } from '../Common/Message';
+// import { XP_REQUEST_MODE } from '../constants';
 
 export const BaseContentType = ({
 	component,
@@ -22,7 +23,7 @@ export const BaseContentType = ({
 		// warning,
 	} = component;
 
-	// if (warning && (mode === 'edit' || mode === 'inline')) {
+	// if (warning && (mode === XP_REQUEST_MODE.EDIT || mode === XP_REQUEST_MODE.INLINE || mode === XP_REQUEST_MODE.ADMIN)) {
 	// 	return (
 	// 		<Message mode={mode}>{warning}</Message>
 	// 	);

diff --git a/src/ComponentRegistry/BaseLayout.tsx b/src/ComponentRegistry/BaseLayout.tsx
@@ -6,6 +6,7 @@ import type {
 
 import * as React from 'react';
 import { Message } from '../Common/Message';
+import { XP_REQUEST_MODE } from '../constants';
 
 export function BaseLayout({
 	component,
@@ -21,9 +22,9 @@ export function BaseLayout({
 		warning,
 	} = component;
 
-	const dataPortalComponentType = mode === 'edit' ? 'layout' : undefined;
+	const dataPortalComponentType = mode === XP_REQUEST_MODE.EDIT ? 'layout' : undefined;
 
-	if (warning && (mode === 'edit' || mode === 'inline')) {
+	if (warning && (mode === XP_REQUEST_MODE.EDIT || mode === XP_REQUEST_MODE.INLINE || mode === XP_REQUEST_MODE.ADMIN)) {
 		return (
 			<Message {...{
 				'data-portal-component-type': dataPortalComponentType,

diff --git a/src/ComponentRegistry/BasePage.tsx b/src/ComponentRegistry/BasePage.tsx
@@ -7,6 +7,7 @@ import type {
 import * as React from 'react';
 import { Message } from '../Common/Message';
 import { ErrorComponent } from '../Common/ErrorComponent';
+import { XP_REQUEST_MODE } from '../constants';
 
 export function BasePage({
 	component,
@@ -23,7 +24,7 @@ export function BasePage({
 		warning,
 	} = component;
 
-	const dataPortalComponentType = mode === 'edit' ? 'page' : undefined;
+	const dataPortalComponentType = mode === XP_REQUEST_MODE.EDIT ? 'page' : undefined;
 
 	if (error && (mode === 'inline' || mode === 'preview')) { // In edit mode the error should be handeled by Content Studio.
 		return (
@@ -34,7 +35,7 @@ export function BasePage({
 		);
 	}
 
-	if (warning && (mode === 'inline' || mode === 'edit')) {
+	if (warning && (mode === XP_REQUEST_MODE.INLINE || mode === XP_REQUEST_MODE.EDIT || mode === XP_REQUEST_MODE.ADMIN)) {
 		return (
 			<Message {...{
 				children: warning,

diff --git a/src/ComponentRegistry/BasePart.tsx b/src/ComponentRegistry/BasePart.tsx
@@ -6,6 +6,7 @@ import type {
 // import { toStr } from '@enonic/js-utils/value/toStr';
 import * as React from 'react';
 import { Message } from '../Common/Message';
+import { XP_REQUEST_MODE } from '../constants';
 
 export function BasePart({
 	component,
@@ -22,9 +23,9 @@ export function BasePart({
 		warning,
 	} = component;
 
-	const dataPortalComponentType = mode === 'edit' ? 'part' : undefined;
+	const dataPortalComponentType = mode === XP_REQUEST_MODE.EDIT ? 'part' : undefined;
 
-	if (warning && (mode === 'edit' || mode === 'inline')) {
+	if (warning && (mode === XP_REQUEST_MODE.EDIT || mode === XP_REQUEST_MODE.INLINE || mode === XP_REQUEST_MODE.ADMIN)) {
 		return (
 			<Message {...{
 				children: warning,

diff --git a/src/ComponentRegistry/BaseText.tsx b/src/ComponentRegistry/BaseText.tsx
@@ -9,6 +9,7 @@ import * as React from 'react';
 import { Message } from '../Common/Message';
 import { XpFallback } from './XpFallback';
 import { Text } from './Text';
+import { XP_REQUEST_MODE } from '../constants';
 
 export const BaseText = ({
 	component,
@@ -22,10 +23,10 @@ export const BaseText = ({
 		props
 	} = component;
 
-	const dataPortalComponentType = mode === 'edit' ? 'text' : undefined;
+	const dataPortalComponentType = mode === XP_REQUEST_MODE.EDIT ? 'text' : undefined;
 
 	if (!props) {
-		if (mode === 'edit' || mode === 'inline') {
+		if (mode === XP_REQUEST_MODE.EDIT || mode === XP_REQUEST_MODE.INLINE || mode === XP_REQUEST_MODE.ADMIN) {
 			return (
 				<Message {...{
 					'data-portal-component-type': dataPortalComponentType,

diff --git a/src/RichText/ErrorBoundary/ErrorBoundaryServer.tsx b/src/RichText/ErrorBoundary/ErrorBoundaryServer.tsx
@@ -4,6 +4,7 @@ import type {
 } from '@enonic-types/core';
 import * as React from 'react';
 import { Message } from '../../Common/Message';
+import { XP_REQUEST_MODE } from '../../constants';
 
 // ErrorBoundaries are not supported on server in Next.js
 export function ErrorBoundaryServer({
@@ -21,7 +22,7 @@ export function ErrorBoundaryServer({
 				<h2>Error rendering component</h2>
 				<p>{e.message}</p>
 				{
-					mode === 'edit' && (
+					mode === XP_REQUEST_MODE.EDIT && (
 						<pre>{e.stack || ''}</pre>
 					)
 				}

diff --git a/src/constants.ts b/src/constants.ts
@@ -1,7 +1,4 @@
-import type {
-	CSSProperties,
-	ReactNode,
-} from 'react';
+import type { CSSProperties } from 'react';
 
 export const IMG_TAG = 'img';
 export const LINK_TAG = 'a';
@@ -23,6 +20,7 @@ export enum RENDERABLE_COMPONENT_TYPE {
 }
 
 export enum XP_REQUEST_MODE {
+	ADMIN = 'admin',
 	EDIT = 'edit',
 	INLINE = 'inline',
 	LIVE = 'live',