snapshot of https://github.com/RocketChat/Rocket.Chat.git (develop, 2026-09-16; blobs > 131072B omitted)

apps/meteor/tests/mocks/data.ts

@@ -0,0 +1,502 @@
+import { faker } from '@faker-js/faker';
+import type { IExternalComponentRoomInfo } from '@rocket.chat/apps/dist/client/definition/IExternalComponentRoomInfo';
+import type { IExternalComponentUserInfo } from '@rocket.chat/apps/dist/client/definition/IExternalComponentUserInfo';
+import type { ILivechatContact } from '@rocket.chat/apps-engine/definition/livechat';
+import {
+	AppSubscriptionStatus,
+	ILivechatAgentStatus,
+	LivechatPriorityWeight,
+	OmnichannelSourceType,
+	UserStatus,
+} from '@rocket.chat/core-typings';
+import type {
+	LicenseInfo,
+	App,
+	IMessage,
+	IRoom,
+	IUser,
+	ILivechatContactChannel,
+	Serialized,
+	ILivechatAgent,
+	ILivechatTag,
+	IOmnichannelBusinessUnit,
+	ILivechatDepartment,
+	ILivechatMonitor,
+	IOmnichannelRoom,
+} from '@rocket.chat/core-typings';
+import { parse } from '@rocket.chat/message-parser';
+import type { ILivechatContactWithManagerData } from '@rocket.chat/rest-typings';
+import type { SubscriptionWithRoom } from '@rocket.chat/ui-contexts';
+
+import type { MessageWithMdEnforced } from '../../client/lib/parseMessageTextToAstMarkdown';
+
+export function createFakeUser<TUser extends IUser>(overrides?: Partial<IUser> & Omit<TUser, keyof IUser>): TUser;
+export function createFakeUser(overrides?: Partial<IUser>): IUser {
+	return {
+		_id: faker.database.mongodbObjectId(),
+		_updatedAt: faker.date.recent(),
+		username: faker.internet.userName(),
+		name: faker.person.fullName(),
+		createdAt: faker.date.recent(),
+		roles: ['user'],
+		active: faker.datatype.boolean(),
+		type: 'user',
+		...overrides,
+	};
+}
+
+export const createFakeRoom = <T extends IRoom = IRoom>(overrides?: Partial<T & { retention?: { enabled: boolean } }>): T =>
+	({
+		_id: faker.database.mongodbObjectId(),
+		_updatedAt: faker.date.recent(),
+		t: faker.helpers.arrayElement(['c', 'p', 'd']),
+		msgs: faker.number.int({ min: 0 }),
+		u: {
+			_id: faker.database.mongodbObjectId(),
+			username: faker.internet.userName(),
+			name: faker.person.fullName(),
+			...overrides?.u,
+		},
+		usersCount: faker.number.int({ min: 0 }),
+		autoTranslateLanguage: faker.helpers.arrayElement(['en', 'es', 'pt', 'ar', 'it', 'ru', 'fr']),
+		...overrides,
+	}) as T;
+
+export const createFakeOmnichannelRoom = (overrides?: Partial<IOmnichannelRoom>): IOmnichannelRoom => ({
+	_id: faker.database.mongodbObjectId(),
+	_updatedAt: faker.date.recent(),
+	t: 'l',
+	msgs: faker.number.int({ min: 0 }),
+	ts: faker.date.recent(),
+	u: {
+		_id: faker.database.mongodbObjectId(),
+		username: faker.internet.userName(),
+		name: faker.person.fullName(),
+		...overrides?.u,
+	},
+	v: {
+		_id: faker.database.mongodbObjectId(),
+		username: faker.internet.userName(),
+		name: faker.person.fullName(),
+		status: UserStatus.ONLINE,
+		token: faker.string.uuid(),
+		activity: [],
+		...overrides?.v,
+	},
+	source: {
+		type: OmnichannelSourceType.WIDGET,
+		...overrides?.source,
+	},
+	usersCount: faker.number.int({ min: 0 }),
+	priorityWeight: LivechatPriorityWeight.NOT_SPECIFIED,
+	estimatedWaitingTimeQueue: faker.number.int({ min: 0, max: 100 }),
+	waitingResponse: faker.datatype.boolean(),
+	livechatData: {},
+	...overrides,
+});
+
+export const createFakeSubscription = (overrides?: Partial<SubscriptionWithRoom>): SubscriptionWithRoom => ({
+	_id: faker.database.mongodbObjectId(),
+	_updatedAt: faker.date.recent(),
+	u: {
+		_id: faker.database.mongodbObjectId(),
+		username: faker.internet.userName(),
+		name: faker.person.fullName(),
+		...overrides?.u,
+	},
+	rid: faker.database.mongodbObjectId(),
+	open: faker.datatype.boolean(),
+	ts: faker.date.recent(),
+	name: faker.person.fullName(),
+	unread: faker.number.int({ min: 0 }),
+	t: faker.helpers.arrayElement(['c', 'p', 'd']),
+	ls: faker.date.recent(),
+	lr: faker.date.recent(),
+	userMentions: faker.number.int({ min: 0 }),
+	groupMentions: faker.number.int({ min: 0 }),
+	lowerCaseName: faker.person.fullName().toLowerCase(),
+	lowerCaseFName: faker.person.fullName().toLowerCase(),
+	usersCount: faker.number.int({ min: 0 }),
+	waitingResponse: faker.datatype.boolean(),
+	priorityWeight: LivechatPriorityWeight.NOT_SPECIFIED,
+	estimatedWaitingTimeQueue: faker.number.int({ min: 0, max: 100 }),
+	livechatData: faker.date.recent(),
+	...overrides,
+});
+
+export function createFakeMessage<TMessage extends IMessage>(overrides?: Partial<IMessage> & Omit<TMessage, keyof IMessage>): TMessage;
+export function createFakeMessage(overrides?: Partial<IMessage>): IMessage {
+	return {
+		_id: faker.database.mongodbObjectId(),
+		_updatedAt: faker.date.recent(),
+		rid: faker.database.mongodbObjectId(),
+		msg: faker.lorem.sentence(),
+		ts: faker.date.recent(),
+		u: {
+			_id: faker.database.mongodbObjectId(),
+			username: faker.internet.userName(),
+			name: faker.person.fullName(),
+			...overrides?.u,
+		},
+		...overrides,
+	};
+}
+
+export function createFakeMessageWithMd<TMessage extends IMessage>(
+	overrides?: Partial<MessageWithMdEnforced<TMessage>>,
+): MessageWithMdEnforced<TMessage>;
+export function createFakeMessageWithMd(overrides?: Partial<MessageWithMdEnforced<IMessage>>): MessageWithMdEnforced<IMessage> {
+	const fakeMessage = createFakeMessage(overrides);
+
+	return {
+		...fakeMessage,
+		md: parse(fakeMessage.msg),
+		...overrides,
+	};
+}
+
+export function createFakeApp(partialApp: Partial<App> = {}): App {
+	const appId = faker.database.mongodbObjectId();
+
+	const app: App = {
+		id: appId,
+		iconFileData: faker.image.dataUri(),
+		name: faker.commerce.productName(),
+		appRequestStats: {
+			appId: partialApp.id ?? appId,
+			totalSeen: faker.number.int({ min: 0, max: 100 }),
+			totalUnseen: faker.number.int({ min: 0, max: 100 }),
+		},
+		author: {
+			name: faker.company.name(),
+			homepage: faker.internet.url(),
+			support: faker.internet.email(),
+		},
+		description: faker.lorem.paragraph(),
+		shortDescription: faker.lorem.sentence(),
+		privacyPolicySummary: faker.lorem.sentence(),
+		detailedDescription: {
+			raw: faker.lorem.paragraph(),
+			rendered: faker.lorem.paragraph(),
+		},
+		detailedChangelog: {
+			raw: faker.lorem.paragraph(),
+			rendered: faker.lorem.paragraph(),
+		},
+		categories: [],
+		version: faker.system.semver(),
+		versionIncompatible: faker.datatype.boolean(),
+		price: faker.number.float({ min: 0, max: 1000 }),
+		purchaseType: faker.helpers.arrayElement(['buy', 'subscription']),
+		pricingPlans: [],
+		iconFileContent: faker.image.dataUri(),
+		isSubscribed: faker.datatype.boolean(),
+		bundledIn: [],
+		marketplaceVersion: faker.system.semver(),
+		get latest() {
+			return app;
+		},
+		subscriptionInfo: {
+			typeOf: faker.lorem.word(),
+			status: faker.helpers.enumValue(AppSubscriptionStatus),
+			statusFromBilling: faker.datatype.boolean(),
+			isSeatBased: faker.datatype.boolean(),
+			seats: faker.number.int({ min: 0, max: 50 }),
+			maxSeats: faker.number.int({ min: 50, max: 100 }),
+			license: {
+				license: faker.lorem.word(),
+				version: faker.number.int({ min: 0, max: 3 }),
+				expireDate: faker.date.future().toISOString(),
+			},
+			startDate: faker.date.past().toISOString(),
+			periodEnd: faker.date.future().toISOString(),
+			endDate: faker.date.future().toISOString(),
+			isSubscribedViaBundle: faker.datatype.boolean(),
+		},
+		tosLink: faker.internet.url(),
+		privacyLink: faker.internet.url(),
+		modifiedAt: faker.date.recent().toISOString(),
+		permissions: faker.helpers.multiple(() => ({
+			name: faker.hacker.verb(),
+			required: faker.datatype.boolean(),
+		})),
+		languages: faker.helpers.multiple(() => faker.location.countryCode()),
+		createdDate: faker.date.past().toISOString(),
+		private: faker.datatype.boolean(),
+		documentationUrl: faker.internet.url(),
+		migrated: faker.datatype.boolean(),
+		...partialApp,
+	};
+
+	return app;
+}
+
+export const createFakeExternalComponentUserInfo = (partial: Partial<IExternalComponentUserInfo> = {}): IExternalComponentUserInfo => ({
+	id: faker.database.mongodbObjectId(),
+	username: faker.internet.userName(),
+	avatarUrl: faker.image.avatar(),
+	...partial,
+});
+
+export const createFakeExternalComponentRoomInfo = (partial: Partial<IExternalComponentRoomInfo> = {}): IExternalComponentRoomInfo => ({
+	id: faker.database.mongodbObjectId(),
+	members: faker.helpers.multiple(createFakeExternalComponentUserInfo),
+	slugifiedName: faker.lorem.slug(),
+	...partial,
+});
+
+export const createFakeLicenseInfo = (partial: Partial<Omit<LicenseInfo, 'license'>> = {}): Omit<LicenseInfo, 'license'> => ({
+	activeModules: faker.helpers.arrayElements([
+		'auditing',
+		'canned-responses',
+		'ldap-enterprise',
+		'livechat-enterprise',
+		'voip-enterprise',
+		'omnichannel-mobile-enterprise',
+		'engagement-dashboard',
+		'push-privacy',
+		'scalability',
+		'teams-mention',
+		'saml-enterprise',
+		'oauth-enterprise',
+		'device-management',
+		'federation',
+		'videoconference-enterprise',
+		'message-read-receipt',
+		'outlook-calendar',
+		'hide-watermark',
+		'custom-roles',
+		'accessibility-certification',
+		'outbound-messaging',
+		'abac',
+	]),
+	externalModules: [],
+	preventedActions: {
+		activeUsers: faker.datatype.boolean(),
+		guestUsers: faker.datatype.boolean(),
+		roomsPerGuest: faker.datatype.boolean(),
+		privateApps: faker.datatype.boolean(),
+		marketplaceApps: faker.datatype.boolean(),
+		monthlyActiveContacts: faker.datatype.boolean(),
+	},
+	limits: {
+		activeUsers: { value: faker.number.int({ min: 0 }), max: faker.number.int({ min: 0 }) },
+		guestUsers: { value: faker.number.int({ min: 0 }), max: faker.number.int({ min: 0 }) },
+		roomsPerGuest: { value: faker.number.int({ min: 0 }), max: faker.number.int({ min: 0 }) },
+		privateApps: { value: faker.number.int({ min: 0 }), max: faker.number.int({ min: 0 }) },
+		marketplaceApps: { value: faker.number.int({ min: 0 }), max: faker.number.int({ min: 0 }) },
+		monthlyActiveContacts: { value: faker.number.int({ min: 0 }), max: faker.number.int({ min: 0 }) },
+	},
+	tags: faker.helpers.multiple(() => ({
+		name: faker.commerce.productAdjective(),
+		color: faker.internet.color(),
+	})),
+	trial: faker.datatype.boolean(),
+	hasValidLicense: faker.datatype.boolean(),
+	...partial,
+});
+
+export function createFakeMessageWithAttachment<TMessage extends IMessage>(overrides?: Partial<TMessage>): TMessage;
+export function createFakeMessageWithAttachment(overrides?: Partial<IMessage>): IMessage {
+	const fakeMessage = createFakeMessage(overrides);
+	const fileId = faker.database.mongodbObjectId();
+	const fileName = faker.system.commonFileName('txt');
+
+	return {
+		...fakeMessage,
+		msg: '',
+		file: {
+			_id: fileId,
+			name: fileName,
+			type: 'text/plain',
+			size: faker.number.int(),
+			format: faker.string.alpha(),
+		},
+		attachments: [
+			{
+				type: 'file',
+				title: fileName,
+				title_link: `/file-upload/${fileId}/${fileName}`,
+			},
+		],
+		files: [
+			{
+				_id: fileId,
+				name: fileName,
+				type: 'text/plain',
+				size: faker.number.int(),
+				format: faker.string.alpha(),
+			},
+		],
+		...overrides,
+	};
+}
+
+const guestNames = faker.helpers.uniqueArray(faker.person.firstName, 1000);
+
+function pullNextVisitorName() {
+	const guestName = guestNames.pop();
+
+	if (!guestName) {
+		throw new Error('exhausted guest names');
+	}
+
+	return guestName;
+}
+
+export function createFakeVisitor() {
+	return {
+		name: pullNextVisitorName(),
+		email: faker.internet.email(),
+	} as const;
+}
+
+export function createFakeContactChannel(overrides?: Partial<Serialized<ILivechatContactChannel>>): Serialized<ILivechatContactChannel> {
+	return {
+		name: 'widget',
+		blocked: false,
+		verified: false,
+		...overrides,
+		visitor: {
+			visitorId: faker.string.uuid(),
+			source: {
+				type: OmnichannelSourceType.WIDGET,
+			},
+			...overrides?.visitor,
+		},
+		details: {
+			type: OmnichannelSourceType.WIDGET,
+			destination: '',
+			...overrides?.details,
+		},
+	};
+}
+
+export function createFakeContact(overrides?: Partial<Serialized<ILivechatContact>>): Serialized<ILivechatContact> {
+	return {
+		_id: faker.string.uuid(),
+		_updatedAt: new Date().toISOString(),
+		name: pullNextVisitorName(),
+		phones: [{ phoneNumber: faker.phone.number() }],
+		emails: [{ address: faker.internet.email() }],
+		unknown: true,
+		channels: [createFakeContactChannel()],
+		createdAt: new Date().toISOString(),
+		...overrides,
+	};
+}
+
+export function createFakeContactWithManagerData(
+	overrides?: Partial<Serialized<ILivechatContactWithManagerData>>,
+): Serialized<ILivechatContactWithManagerData> {
+	const { contactManager: contactManagerOverwrites, ...contactOverwrites } = overrides || {};
+	const contact = createFakeContact(contactOverwrites);
+	return {
+		...contact,
+		contactManager: {
+			_id: faker.string.uuid(),
+			name: faker.person.fullName(),
+			username: faker.internet.userName(),
+			...contactManagerOverwrites,
+		},
+	};
+}
+
+export function createFakeAgent(overrides?: Partial<Serialized<ILivechatAgent>>): Serialized<ILivechatAgent> {
+	const email = faker.internet.email();
+	const firstName = faker.person.firstName();
+	const lastName = faker.person.lastName();
+	const username = faker.internet.userName({ firstName, lastName });
+
+	return {
+		_id: faker.string.uuid(),
+		username,
+		status: UserStatus.ONLINE,
+		statusLivechat: ILivechatAgentStatus.AVAILABLE,
+		name: `${firstName} ${lastName}`,
+		emails: [
+			{
+				address: email,
+				verified: false,
+			},
+		],
+		livechat: {
+			maxNumberSimultaneousChat: 0,
+		},
+		lastRoutingTime: '',
+		livechatCount: 0,
+		active: true,
+		createdAt: new Date().toISOString(),
+		_updatedAt: new Date().toISOString(),
+		roles: [],
+		type: '',
+		...overrides,
+	};
+}
+
+export function createFakeTag(overrides?: Partial<Serialized<ILivechatTag>>): Serialized<ILivechatTag> {
+	return {
+		_id: faker.string.uuid(),
+		name: faker.commerce.department(),
+		description: 'description',
+		numDepartments: 0,
+		departments: [],
+		_updatedAt: new Date().toISOString(),
+		...overrides,
+	};
+}
+
+export function createFakeBusinessUnit(overrides?: Partial<Serialized<IOmnichannelBusinessUnit>>): Serialized<IOmnichannelBusinessUnit> {
+	return {
+		_id: faker.string.uuid(),
+		name: faker.commerce.department(),
+		visibility: 'public',
+		type: 'u',
+		numMonitors: 1,
+		numDepartments: 1,
+		_updatedAt: new Date().toISOString(),
+		...overrides,
+	};
+}
+
+export const createFakeDepartment = (overrides: Partial<Serialized<ILivechatDepartment>> = {}): Serialized<ILivechatDepartment> => ({
+	_id: faker.string.uuid(),
+	name: `${faker.commerce.department()} ${faker.string.uuid()}`,
+	enabled: true,
+	email: faker.internet.email(),
+	showOnRegistration: false,
+	showOnOfflineForm: false,
+	type: 'd',
+	_updatedAt: new Date().toISOString(),
+	offlineMessageChannelName: '',
+	numAgents: 0,
+	ancestors: undefined,
+	parentId: undefined,
+	...overrides,
+});
+
+export function createFakeMonitor(overrides?: Partial<Serialized<ILivechatMonitor>>): Serialized<ILivechatMonitor> {
+	const firstName = faker.person.firstName();
+	const lastName = faker.person.lastName();
+	const username = faker.internet.userName({ firstName, lastName });
+
+	return {
+		_id: faker.string.uuid(),
+		username,
+		name: `${firstName} ${lastName}`,
+		type: '',
+		enabled: true,
+		numMonitors: 0,
+		visibility: 'visible',
+		...overrides,
+	};
+}
+
+export const createMockedPagination = (results = 0, total = 0) => ({
+	current: 0,
+	setCurrent: () => undefined,
+	itemsPerPage: 25 as const,
+	setItemsPerPage: () => undefined,
+	itemsPerPageLabel: () => 'Items per page:',
+	showingResultsLabel: () => `Showing results 1 - ${results} of ${total}`,
+});