Skip to content

Enhanced ChatGPT Clone: Features Agents, MCP, Skills, DeepSeek, Anthropic, AWS, OpenAI, Responses API, Azure, Groq, o1, GPT-5, Mistral, OpenRouter, Vertex AI, Gemini, Artifacts, AI model switching, message search, Code Interpreter, langchain, DALL-E-3, OpenAPI Actions, Functions, Secure Multi-User Auth, Presets, open-source for self-hosting. Active

🚀 feat: Banner (#3952)

Yuichi Onedaaea01f0bc5ce
diff --git a/api/models/Banner.js b/api/models/Banner.js
new file mode 100644
index 0000000000..8d439dae28
--- /dev/null
+++ b/api/models/Banner.js
@@ -0,0 +1,27 @@
+const Banner = require('./schema/banner');
+const logger = require('~/config/winston');
+/**
+ * Retrieves the current active banner.
+ * @returns {Promise<Object|null>} The active banner object or null if no active banner is found.
+ */
+const getBanner = async (user) => {
+ try {
+ const now = new Date();
+ const banner = await Banner.findOne({
+ displayFrom: { $lte: now },
+ $or: [{ displayTo: { $gte: now } }, { displayTo: null }],
+ type: 'banner',
+ }).lean();
+
+ if (!banner || banner.isPublic || user) {
+ return banner;
+ }
+
+ return null;
+ } catch (error) {
+ logger.error('[getBanners] Error getting banners', error);
+ throw new Error('Error getting banners');
+ }
+};
+
+module.exports = { getBanner };
diff --git a/api/models/schema/banner.js b/api/models/schema/banner.js
new file mode 100644
index 0000000000..7fd86c1b67
--- /dev/null
+++ b/api/models/schema/banner.js
@@ -0,0 +1,36 @@
+const mongoose = require('mongoose');
+
+const bannerSchema = mongoose.Schema(
+ {
+ bannerId: {
+ type: String,
+ required: true,
+ },
+ message: {
+ type: String,
+ required: true,
+ },
+ displayFrom: {
+ type: Date,
+ required: true,
+ default: Date.now,
+ },
+ displayTo: {
+ type: Date,
+ },
+ type: {
+ type: String,
+ enum: ['banner', 'popup'],
+ default: 'banner',
+ },
+ isPublic: {
+ type: Boolean,
+ default: false,
+ },
+ },
+
+ { timestamps: true },
+);
+
+const Banner = mongoose.model('Banner', bannerSchema);
+module.exports = Banner;
diff --git a/api/server/index.js b/api/server/index.js
index 47ce354f2a..8c4d3250f8 100644
--- a/api/server/index.js
+++ b/api/server/index.js
@@ -106,6 +106,7 @@ const startServer = async () => {
app.use('/api/share', routes.share);
app.use('/api/roles', routes.roles);
app.use('/api/agents', routes.agents);
+ app.use('/api/banner', routes.banner);
app.use('/api/bedrock', routes.bedrock);
app.use('/api/tags', routes.tags);
diff --git a/api/server/middleware/optionalJwtAuth.js b/api/server/middleware/optionalJwtAuth.js
new file mode 100644
index 0000000000..8aa1c27e00
--- /dev/null
+++ b/api/server/middleware/optionalJwtAuth.js
@@ -0,0 +1,17 @@
+const passport = require('passport');
+
+// This middleware does not require authentication,
+// but if the user is authenticated, it will set the user object.
+const optionalJwtAuth = (req, res, next) => {
+ passport.authenticate('jwt', { session: false }, (err, user) => {
+ if (err) {
+ return next(err);
+ }
+ if (user) {
+ req.user = user;
+ }
+ next();
+ })(req, res, next);
+};
+
+module.exports = optionalJwtAuth;
diff --git a/api/server/routes/banner.js b/api/server/routes/banner.js
new file mode 100644
index 0000000000..cf7eafd017
--- /dev/null
+++ b/api/server/routes/banner.js
@@ -0,0 +1,15 @@
+const express = require('express');
+
+const { getBanner } = require('~/models/Banner');
+const optionalJwtAuth = require('~/server/middleware/optionalJwtAuth');
+const router = express.Router();
+
+router.get('/', optionalJwtAuth, async (req, res) => {
+ try {
+ res.status(200).send(await getBanner(req.user));
+ } catch (error) {
+ res.status(500).json({ message: 'Error getting banner' });
+ }
+});
+
+module.exports = router;
diff --git a/api/server/routes/index.js b/api/server/routes/index.js
index 3790aacd24..4aba91e954 100644
--- a/api/server/routes/index.js
+++ b/api/server/routes/index.js
@@ -24,6 +24,7 @@ const edit = require('./edit');
const keys = require('./keys');
const user = require('./user');
const ask = require('./ask');
+const banner = require('./banner');
module.exports = {
ask,
@@ -52,4 +53,5 @@ module.exports = {
assistants,
categories,
staticRoute,
+ banner,
};
diff --git a/client/src/components/Auth/AuthLayout.tsx b/client/src/components/Auth/AuthLayout.tsx
index 9f222a110a..0ff99f357c 100644
--- a/client/src/components/Auth/AuthLayout.tsx
+++ b/client/src/components/Auth/AuthLayout.tsx
@@ -3,6 +3,7 @@ import { BlinkAnimation } from './BlinkAnimation';
import { TStartupConfig } from 'librechat-data-provider';
import SocialLoginRender from './SocialLoginRender';
import { ThemeSelector } from '~/components/ui';
+import { Banner } from '../Banners';
import Footer from './Footer';
const ErrorRender = ({ children }: { children: React.ReactNode }) => (
@@ -56,6 +57,7 @@ function AuthLayout({
return (
<div className="relative flex min-h-screen flex-col bg-white dark:bg-gray-900">
+ <Banner />
<BlinkAnimation active={isFetching}>
<div className="mt-6 h-10 w-full bg-cover">
<img src="/assets/logo.svg" className="h-full w-full object-contain" alt="Logo" />
diff --git a/client/src/components/Auth/__tests__/Login.spec.tsx b/client/src/components/Auth/__tests__/Login.spec.tsx
index 71c3d6592b..288d796850 100644
--- a/client/src/components/Auth/__tests__/Login.spec.tsx
+++ b/client/src/components/Auth/__tests__/Login.spec.tsx
@@ -54,6 +54,11 @@ const setup = ({
},
},
useGetStartupConfigReturnValue = mockStartupConfig,
+ useGetBannerQueryReturnValue = {
+ isLoading: false,
+ isError: false,
+ data: {},
+ },
} = {}) => {
const mockUseLoginUser = jest
.spyOn(mockDataProvider, 'useLoginUserMutation')
@@ -71,6 +76,10 @@ const setup = ({
.spyOn(mockDataProvider, 'useRefreshTokenMutation')
//@ts-ignore - we don't need all parameters of the QueryObserverSuccessResult
.mockReturnValue(useRefreshTokenMutationReturnValue);
+ const mockUseGetBannerQuery = jest
+ .spyOn(mockDataProvider, 'useGetBannerQuery')
+ //@ts-ignore - we don't need all parameters of the QueryObserverSuccessResult
+ .mockReturnValue(useGetBannerQueryReturnValue);
const mockUseOutletContext = jest.spyOn(reactRouter, 'useOutletContext').mockReturnValue({
startupConfig: useGetStartupConfigReturnValue.data,
});
@@ -93,6 +102,7 @@ const setup = ({
mockUseOutletContext,
mockUseGetStartupConfig,
mockUseRefreshTokenMutation,
+ mockUseGetBannerQuery,
};
};
diff --git a/client/src/components/Auth/__tests__/LoginForm.spec.tsx b/client/src/components/Auth/__tests__/LoginForm.spec.tsx
index d30b709eb2..eca8e6ef51 100644
--- a/client/src/components/Auth/__tests__/LoginForm.spec.tsx
+++ b/client/src/components/Auth/__tests__/LoginForm.spec.tsx
@@ -59,6 +59,11 @@ const setup = ({
isError: false,
data: mockStartupConfig,
},
+ useGetBannerQueryReturnValue = {
+ isLoading: false,
+ isError: false,
+ data: {},
+ },
} = {}) => {
const mockUseLoginUser = jest
.spyOn(mockDataProvider, 'useLoginUserMutation')
@@ -76,11 +81,16 @@ const setup = ({
.spyOn(mockDataProvider, 'useRefreshTokenMutation')
//@ts-ignore - we don't need all parameters of the QueryObserverSuccessResult
.mockReturnValue(useRefreshTokenMutationReturnValue);
+ const mockUseGetBannerQuery = jest
+ .spyOn(mockDataProvider, 'useGetBannerQuery')
+ //@ts-ignore - we don't need all parameters of the QueryObserverSuccessResult
+ .mockReturnValue(useGetBannerQueryReturnValue);
return {
mockUseLoginUser,
mockUseGetUserQuery,
mockUseGetStartupConfig,
mockUseRefreshTokenMutation,
+ mockUseGetBannerQuery,
};
};
diff --git a/client/src/components/Auth/__tests__/Registration.spec.tsx b/client/src/components/Auth/__tests__/Registration.spec.tsx
index 16d2761754..0a9b6d4da9 100644
--- a/client/src/components/Auth/__tests__/Registration.spec.tsx
+++ b/client/src/components/Auth/__tests__/Registration.spec.tsx
@@ -50,6 +50,11 @@ const setup = ({
user: {},
},
},
+ useGetBannerQueryReturnValue = {
+ isLoading: false,
+ isError: false,
+ data: {},
+ },
useGetStartupConfigReturnValue = mockStartupConfig,
} = {}) => {
const mockUseRegisterUserMutation = jest
@@ -71,6 +76,10 @@ const setup = ({
const mockUseOutletContext = jest.spyOn(reactRouter, 'useOutletContext').mockReturnValue({
startupConfig: useGetStartupConfigReturnValue.data,
});
+ const mockUseGetBannerQuery = jest
+ .spyOn(mockDataProvider, 'useGetBannerQuery')
+ //@ts-ignore - we don't need all parameters of the QueryObserverSuccessResult
+ .mockReturnValue(useGetBannerQueryReturnValue);
const renderResult = render(
<AuthLayout
startupConfig={useGetStartupConfigReturnValue.data as TStartupConfig}
diff --git a/client/src/components/Banners/Banner.tsx b/client/src/components/Banners/Banner.tsx
new file mode 100644
index 0000000000..cf6fcae570
--- /dev/null
+++ b/client/src/components/Banners/Banner.tsx
@@ -0,0 +1,48 @@
+import { XIcon } from 'lucide-react';
+import { useRecoilState } from 'recoil';
+import { useGetBannerQuery } from 'librechat-data-provider/react-query';
+import store from '~/store';
+import { useEffect, useRef } from 'react';
+
+export const Banner = ({ onHeightChange }: { onHeightChange?: (height: number) => void }) => {
+ const { data: banner } = useGetBannerQuery();
+ const [hideBannerHint, setHideBannerHint] = useRecoilState<string[]>(store.hideBannerHint);
+ const bannerRef = useRef<HTMLDivElement>(null);
+
+ useEffect(() => {
+ if (onHeightChange && bannerRef.current) {
+ onHeightChange(bannerRef.current.offsetHeight);
+ }
+ }, [banner, hideBannerHint, onHeightChange]);
+
+ if (!banner || (banner.bannerId && hideBannerHint.includes(banner.bannerId))) {
+ return null;
+ }
+
+ const onClick = () => {
+ setHideBannerHint([...hideBannerHint, banner.bannerId]);
+ if (onHeightChange) {
+ onHeightChange(0); // Reset height when banner is closed
+ }
+ };
+
+ return (
+ <div
+ ref={bannerRef}
+ className="sticky top-0 z-20 flex items-center bg-neutral-900 from-gray-700 to-gray-900 px-2 py-1 text-slate-50 dark:bg-gradient-to-r dark:text-white md:relative"
+ >
+ <div
+ className="w-full truncate px-4 text-center text-sm"
+ dangerouslySetInnerHTML={{ __html: banner.message }}
+ ></div>
+ <button
+ type="button"
+ aria-label="Dismiss banner"
+ className="h-8 w-8 opacity-80 hover:opacity-100"
+ onClick={onClick}
+ >
+ <XIcon className="mx-auto h-4 w-4" />
+ </button>
+ </div>
+ );
+};
diff --git a/client/src/components/Banners/index.ts b/client/src/components/Banners/index.ts
new file mode 100644
index 0000000000..f4930c0719
--- /dev/null
+++ b/client/src/components/Banners/index.ts
@@ -0,0 +1 @@
+export { Banner } from './Banner';
diff --git a/client/src/components/ui/OGDialogTemplate.tsx b/client/src/components/ui/OGDialogTemplate.tsx
index 740fd390b8..471d8bad94 100644
--- a/client/src/components/ui/OGDialogTemplate.tsx
+++ b/client/src/components/ui/OGDialogTemplate.tsx
@@ -74,7 +74,7 @@ const OGDialogTemplate = forwardRef((props: DialogTemplateProps, ref: Ref<HTMLDi
<div>{leftButtons != null ? leftButtons : null}</div>
<div className="flex h-auto gap-3">
{showCancelButton && (
- <OGDialogClose className="btn btn-neutral border-token-border-light relative rounded-lg text-sm ring-offset-2 dark:ring-offset-0 focus:ring-2 focus:ring-black">
+ <OGDialogClose className="btn btn-neutral border-token-border-light relative rounded-lg text-sm ring-offset-2 focus:ring-2 focus:ring-black dark:ring-offset-0">
{Cancel}
</OGDialogClose>
)}
diff --git a/client/src/routes/Root.tsx b/client/src/routes/Root.tsx
index 41fc3f242e..6a06323f89 100644
--- a/client/src/routes/Root.tsx
+++ b/client/src/routes/Root.tsx
@@ -8,6 +8,7 @@ import { AgentsMapContext, AssistantsMapContext, FileMapContext, SearchContext }
import { useAuthContext, useAssistantsMap, useAgentsMap, useFileMap, useSearch } from '~/hooks';
import { Nav, MobileNav } from '~/components/Nav';
import TermsAndConditionsModal from '~/components/ui/TermsAndConditionsModal';
+import { Banner } from '~/components/Banners';
export default function Root() {
const { isAuthenticated, logout, token } = useAuthContext();
@@ -16,6 +17,7 @@ export default function Root() {
const savedNavVisible = localStorage.getItem('navVisible');
return savedNavVisible !== null ? JSON.parse(savedNavVisible) : true;
});
+ const [bannerHeight, setBannerHeight] = useState(0);
const search = useSearch({ isAuthenticated });
const fileMap = useFileMap({ isAuthenticated });
@@ -24,7 +26,6 @@ export default function Root() {
const [showTerms, setShowTerms] = useState(false);
const { data: config } = useGetStartupConfig();
-
const { data: termsData } = useUserTermsQuery({
enabled: isAuthenticated && !!config?.interface?.termsOfService?.modalAcceptance,
});
@@ -54,7 +55,8 @@ export default function Root() {
<FileMapContext.Provider value={fileMap}>
<AssistantsMapContext.Provider value={assistantsMap}>
<AgentsMapContext.Provider value={agentsMap}>
- <div className="flex h-dvh">
+ <Banner onHeightChange={setBannerHeight} />
+ <div className="flex" style={{ height: `calc(100dvh - ${bannerHeight}px)` }}>
<div className="relative z-0 flex h-full w-full overflow-hidden">
<Nav navVisible={navVisible} setNavVisible={setNavVisible} />
<div className="relative flex h-full max-w-full flex-1 flex-col overflow-hidden">
diff --git a/client/src/store/banner.ts b/client/src/store/banner.ts
new file mode 100644
index 0000000000..baa0b02728
--- /dev/null
+++ b/client/src/store/banner.ts
@@ -0,0 +1,5 @@
+import { atomWithLocalStorage } from './utils';
+
+const hideBannerHint = atomWithLocalStorage('hideBannerHint', [] as string[]);
+
+export default { hideBannerHint };
diff --git a/client/src/store/index.ts b/client/src/store/index.ts
index 291dc2083e..b0ab47221d 100644
--- a/client/src/store/index.ts
+++ b/client/src/store/index.ts
@@ -12,7 +12,7 @@ import preset from './preset';
import prompts from './prompts';
import lang from './language';
import settings from './settings';
-
+import banner from './banner';
export default {
...artifacts,
...families,
@@ -28,4 +28,5 @@ export default {
...preset,
...lang,
...settings,
+ ...banner,
};
diff --git a/config/delete-banner.js b/config/delete-banner.js
new file mode 100644
index 0000000000..efb89f3418
--- /dev/null
+++ b/config/delete-banner.js
@@ -0,0 +1,61 @@
+const path = require('path');
+require('module-alias')({ base: path.resolve(__dirname, '..', 'api') });
+const { askQuestion, silentExit } = require('./helpers');
+const Banner = require('~/models/schema/banner');
+const connect = require('./connect');
+
+(async () => {
+ await connect();
+
+ console.purple('--------------------------');
+ console.purple('Delete the banner!');
+ console.purple('--------------------------');
+
+ const now = new Date();
+
+ try {
+ const banner = await Banner.findOne({
+ displayFrom: { $lte: now },
+ $or: [{ displayTo: { $gte: now } }, { displayTo: null }],
+ });
+
+ if (!banner) {
+ console.yellow('No banner found to delete.');
+ silentExit(0);
+ }
+
+ console.purple('Current banner:');
+ console.log(`Message: ${banner.message}`);
+ console.log(`Display From: ${banner.displayFrom}`);
+ console.log(`Display To: ${banner.displayTo || 'Not specified'}`);
+ console.log(`Is Public: ${banner.isPublic}`);
+
+ const confirmDelete = await askQuestion('Do you want to delete this banner? (y/N): ');
+
+ if (confirmDelete.toLowerCase() === 'y') {
+ await Banner.findByIdAndDelete(banner._id);
+ console.green('Banner deleted successfully!');
+ } else {
+ console.yellow('Banner deletion cancelled.');
+ }
+ } catch (error) {
+ console.red('Error: ' + error.message);
+ console.error(error);
+ silentExit(1);
+ }
+
+ silentExit(0);
+})();
+
+process.on('uncaughtException', (err) => {
+ if (!err.message.includes('fetch failed')) {
+ console.error('There was an uncaught error:');
+ console.error(err);
+ }
+
+ if (err.message.includes('fetch failed')) {
+ return;
+ } else {
+ process.exit(1);
+ }
+});
diff --git a/config/helpers.js b/config/helpers.js
index 6bc6ed0ef2..d7d679a5a5 100644
--- a/config/helpers.js
+++ b/config/helpers.js
@@ -21,6 +21,27 @@ const askQuestion = (query) => {
);
};
+const askMultiLineQuestion = (query) => {
+ const rl = readline.createInterface({
+ input: process.stdin,
+ output: process.stdout,
+ });
+
+ console.cyan(query);
+
+ return new Promise((resolve) => {
+ let lines = [];
+ rl.on('line', (line) => {
+ if (line.trim() === '.') {
+ rl.close();
+ resolve(lines.join('\n'));
+ } else {
+ lines.push(line);
+ }
+ });
+ });
+};
+
function isDockerRunning() {
try {
execSync('docker info');
@@ -56,6 +77,7 @@ console.gray = (msg) => console.log('\x1b[90m%s\x1b[0m', msg);
module.exports = {
askQuestion,
+ askMultiLineQuestion,
silentExit,
isDockerRunning,
deleteNodeModules,
diff --git a/config/update-banner.js b/config/update-banner.js
new file mode 100644
index 0000000000..4640230bc2
--- /dev/null
+++ b/config/update-banner.js
@@ -0,0 +1,147 @@
+const path = require('path');
+const { v5: uuidv5 } = require('uuid');
+require('module-alias')({ base: path.resolve(__dirname, '..', 'api') });
+const { askQuestion, askMultiLineQuestion, silentExit } = require('./helpers');
+const Banner = require('~/models/schema/banner');
+const connect = require('./connect');
+
+(async () => {
+ await connect();
+
+ /**
+ * Show the welcome / help menu
+ */
+ console.purple('--------------------------');
+ console.purple('Update the banner!');
+ console.purple('--------------------------');
+ /**
+ * Set up the variables we need and get the arguments if they were passed in
+ */
+ let displayFrom = '';
+ let displayTo = '';
+ let message = '';
+ let isPublic = undefined;
+ // If we have the right number of arguments, lets use them
+ if (process.argv.length >= 3) {
+ displayFrom = process.argv[2];
+ displayTo = process.argv[3];
+ message = process.argv[4];
+ isPublic = process.argv[5] === undefined ? undefined : process.argv[5] === 'true';
+ } else {
+ console.orange(
+ 'Usage: npm run update-banner <displayFrom(Format: yyyy-mm-ddTHH:MM:SSZ)> <displayTo(Format: yyyy-mm-ddTHH:MM:SSZ)> <message> <isPublic(true/false)>',
+ );
+ console.orange('Note: if you do not pass in the arguments, you will be prompted for them.');
+ console.purple('--------------------------');
+ }
+
+ /**
+ * If we don't have the right number of arguments, lets prompt the user for them
+ */
+ if (!displayFrom) {
+ displayFrom = await askQuestion('Display From (Format: yyyy-mm-ddTHH:MM:SSZ, Default: now):');
+ }
+
+ // Validate the displayFrom format (ISO 8601)
+ const dateTimeRegex = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z$/;
+ if (displayFrom && !dateTimeRegex.test(displayFrom)) {
+ console.red('Error: Invalid date format for displayFrom. Please use yyyy-mm-ddTHH:MM:SSZ.');
+ silentExit(1);
+ }
+
+ displayFrom = displayFrom ? new Date(displayFrom) : new Date();
+
+ if (!displayTo) {
+ displayTo = await askQuestion(
+ 'Display To (Format: yyyy-mm-ddTHH:MM:SSZ, Default: not specified):',
+ );
+ }
+
+ if (displayTo && !dateTimeRegex.test(displayTo)) {
+ console.red('Error: Invalid date format for displayTo. Please use yyyy-mm-ddTHH:MM:SSZ.');
+ silentExit(1);
+ }
+
+ displayTo = displayTo ? new Date(displayTo) : null;
+
+ if (!message) {
+ message = await askMultiLineQuestion(
+ 'Enter your message ((Enter a single dot "." on a new line to finish)):',
+ );
+ }
+
+ if (message.trim() === '') {
+ console.red('Error: Message cannot be empty!');
+ silentExit(1);
+ }
+
+ if (isPublic === undefined) {
+ const isPublicInput = await askQuestion('Is public (y/N):');
+ isPublic = isPublicInput.toLowerCase() === 'y' ? true : false;
+ }
+
+ // Generate the same bannerId for the same message
+ // This allows us to display only messages that haven't been shown yet
+ const NAMESPACE = '6ba7b810-9dad-11d1-80b4-00c04fd430c8'; // Use an arbitrary namespace UUID
+ const bannerId = uuidv5(message, NAMESPACE);
+
+ let result;
+ try {
+ // There is always only one Banner record in the DB.
+ // If a Banner exists in the DB, it will be updated.
+ // If it doesn't exist, a new one will be added.
+ const existingBanner = await Banner.findOne();
+ if (existingBanner) {
+ result = await Banner.findByIdAndUpdate(
+ existingBanner._id,
+ {
+ displayFrom,
+ displayTo,
+ message,
+ bannerId,
+ isPublic,
+ },
+ { new: true },
+ );
+ } else {
+ result = await Banner.create({
+ displayFrom,
+ displayTo,
+ message,
+ bannerId,
+ isPublic,
+ });
+ }
+ } catch (error) {
+ console.red('Error: ' + error.message);
+ console.error(error);
+ silentExit(1);
+ }
+
+ if (!result) {
+ console.red('Error: Something went wrong while updating the banner!');
+ console.error(result);
+ silentExit(1);
+ }
+
+ console.green('Banner updated successfully!');
+ console.purple(`bannerId: ${bannerId}`);
+ console.purple(`from: ${displayFrom}`);
+ console.purple(`to: ${displayTo || 'not specified'}`);
+ console.purple(`Banner: ${message}`);
+ console.purple(`isPublic: ${isPublic}`);
+ silentExit(0);
+})();
+
+process.on('uncaughtException', (err) => {
+ if (!err.message.includes('fetch failed')) {
+ console.error('There was an uncaught error:');
+ console.error(err);
+ }
+
+ if (err.message.includes('fetch failed')) {
+ return;
+ } else {
+ process.exit(1);
+ }
+});
diff --git a/package.json b/package.json
index d0f6688845..ffdf6d109d 100644
--- a/package.json
+++ b/package.json
@@ -29,6 +29,8 @@
"invite-user": "node config/invite-user.js",
"ban-user": "node config/ban-user.js",
"delete-user": "node config/delete-user.js",
+ "update-banner": "node config/update-banner.js",
+ "delete-banner": "node config/delete-banner.js",
"backend": "cross-env NODE_ENV=production node api/server/index.js",
"backend:dev": "cross-env NODE_ENV=development npx nodemon api/server/index.js",
"backend:stop": "node config/stop-backend.js",
diff --git a/packages/data-provider/src/api-endpoints.ts b/packages/data-provider/src/api-endpoints.ts
index e78f27d67b..dfa6f4eece 100644
--- a/packages/data-provider/src/api-endpoints.ts
+++ b/packages/data-provider/src/api-endpoints.ts
@@ -220,3 +220,4 @@ export const addTagToConversation = (conversationId: string) =>
export const userTerms = () => '/api/user/terms';
export const acceptUserTerms = () => '/api/user/terms/accept';
+export const banner = () => '/api/banner';
diff --git a/packages/data-provider/src/data-service.ts b/packages/data-provider/src/data-service.ts
index b5008b37dd..77114c6011 100644
--- a/packages/data-provider/src/data-service.ts
+++ b/packages/data-provider/src/data-service.ts
@@ -691,3 +691,7 @@ export function getUserTerms(): Promise<t.TUserTermsResponse> {
export function acceptTerms(): Promise<t.TAcceptTermsResponse> {
return request.post(endpoints.acceptUserTerms());
}
+
+export function getBanner(): Promise<t.TBannerResponse> {
+ return request.get(endpoints.banner());
+}
diff --git a/packages/data-provider/src/keys.ts b/packages/data-provider/src/keys.ts
index 9b6cb6c235..a4ed0b121c 100644
--- a/packages/data-provider/src/keys.ts
+++ b/packages/data-provider/src/keys.ts
@@ -43,6 +43,7 @@ export enum QueryKeys {
conversationTags = 'conversationTags',
health = 'health',
userTerms = 'userTerms',
+ banner = 'banner',
}
export enum MutationKeys {
diff --git a/packages/data-provider/src/react-query/react-query-service.ts b/packages/data-provider/src/react-query/react-query-service.ts
index 8d11f040d7..997751358a 100644
--- a/packages/data-provider/src/react-query/react-query-service.ts
+++ b/packages/data-provider/src/react-query/react-query-service.ts
@@ -451,3 +451,14 @@ export const useGetCustomConfigSpeechQuery = (
},
);
};
+
+export const useGetBannerQuery = (
+ config?: UseQueryOptions<t.TBannerResponse>,
+): QueryObserverResult<t.TBannerResponse> => {
+ return useQuery<t.TBannerResponse>([QueryKeys.banner], () => dataService.getBanner(), {
+ refetchOnWindowFocus: false,
+ refetchOnReconnect: false,
+ refetchOnMount: false,
+ ...config,
+ });
+};
diff --git a/packages/data-provider/src/schemas.ts b/packages/data-provider/src/schemas.ts
index 19c8548574..3a4a9d68b8 100644
--- a/packages/data-provider/src/schemas.ts
+++ b/packages/data-provider/src/schemas.ts
@@ -1212,6 +1212,17 @@ export const compactPluginsSchema = tConversationSchema
})
.catch(() => ({}));
+const tBannerSchema = z.object({
+ bannerId: z.string(),
+ message: z.string(),
+ displayFrom: z.string(),
+ displayTo: z.string(),
+ createdAt: z.string(),
+ updatedAt: z.string(),
+ isPublic: z.boolean(),
+});
+export type TBanner = z.infer<typeof tBannerSchema>;
+
export const compactAgentsSchema = tConversationSchema
.pick({
model: true,
diff --git a/packages/data-provider/src/types.ts b/packages/data-provider/src/types.ts
index 4e4c2ded38..26c150e2ca 100644
--- a/packages/data-provider/src/types.ts
+++ b/packages/data-provider/src/types.ts
@@ -8,6 +8,7 @@ import type {
TConversation,
EModelEndpoint,
TConversationTag,
+ TBanner,
} from './schemas';
import type { TSpecsConfig } from './models';
export type TOpenAIMessage = OpenAI.Chat.ChatCompletionMessageParam;
@@ -518,3 +519,5 @@ export type TUserTermsResponse = {
export type TAcceptTermsResponse = {
success: boolean;
};
+
+export type TBannerResponse = TBanner | null;