feat(apps-engine): expose isFederated field in room and user objects to apps

.changeset/true-cooks-lick.md

@@ -0,0 +1,6 @@
+---
+'@rocket.chat/apps-engine': minor
+'@rocket.chat/meteor': minor
+---
+
+Exposes the `isFederated` and `federation` fields for room and user objects in apps

apps/meteor/app/apps/server/bridges/rooms.ts

@@ -37,6 +37,8 @@ const rawRoomProjection: FindOptions<ICoreRoom>['projection'] = {
 	prid: 1,
 	teamId: 1,
 	teamMain: 1,
+	federated: 1,
+	federation: 1,
 	livechatData: 1,
 	waitingResponse: 1,
 	open: 1,

apps/meteor/app/apps/server/converters/rooms.js

@@ -59,6 +59,8 @@ export class AppRoomsConverter {
 			contactId: 'contactId',
 			departmentId: 'departmentId',
 			parentRoomId: 'prid',
+			isFederated: 'federated',
+			federation: 'federation',
 			visitor: (data) => {
 				const { v } = data;
 				if (!v) {
@@ -261,6 +263,8 @@ export class AppRoomsConverter {
 			...(room.lastModifiedAt && { lm: room.lastModifiedAt }),
 			...(room.customFields && { customFields: room.customFields }),
 			...(room.livechatData && { livechatData: room.livechatData }),
+			...(typeof room.isFederated !== 'undefined' && { federated: room.isFederated }),
+			...(typeof room.federation !== 'undefined' && { federation: room.federation }),
 			...(typeof room.parentRoom !== 'undefined' && { prid: room.parentRoom.id }),
 			...(contactId && { contactId }),
 			...(room._USERNAMES && { _USERNAMES: room._USERNAMES }),
@@ -304,6 +308,8 @@ export class AppRoomsConverter {
 			closer: 'closer',
 			teamId: 'teamId',
 			isTeamMain: 'teamMain',
+			isFederated: 'federated',
+			federation: 'federation',
 			isDefault: (room) => {
 				const result = !!room.default;
 				delete room.default;

apps/meteor/app/apps/server/converters/users.js

@@ -45,6 +45,8 @@ export class AppUsersConverter {
 			lastLoginAt: user.lastLogin,
 			appId: user.appId,
 			customFields: user.customFields,
+			isFederated: user.federated,
+			federation: user.federation,
 			sipExtension: user.freeSwitchExtension,
 			settings: {
 				preferences: {
@@ -75,6 +77,8 @@ export class AppUsersConverter {
 			_updatedAt: user.updatedAt,
 			lastLogin: user.lastLoginAt,
 			appId: user.appId,
+			federated: user.isFederated,
+			federation: user.federation,
 			freeSwitchExtension: user.sipExtension,
 		});
 	}

packages/apps-engine/src/definition/federation/FederationLookup.ts

@@ -0,0 +1,5 @@
+export type FederationLookup = {
+	version: number;
+	mrid: string;
+	origin: string;
+};

packages/apps-engine/src/definition/federation/index.ts

@@ -0,0 +1 @@
+export type * from './FederationLookup';

packages/apps-engine/src/definition/rooms/IRoom.ts

@@ -1,4 +1,5 @@
 import type { IAbacAttributeDefinition } from '../abac/AbacAttributes';
+import type { FederationLookup } from '../federation';
 import type { IUser } from '../users';
 import type { RoomType } from './RoomType';
 
@@ -26,6 +27,8 @@ export interface IRoom {
 	customFields?: { [key: string]: any };
 	parentRoom?: IRoom;
 	livechatData?: { [key: string]: any };
+	isFederated?: boolean;
+	federation?: FederationLookup;
 
 	abacAttributes?: IAbacAttributeDefinition[];
 }

packages/apps-engine/src/definition/rooms/IRoomRaw.ts

@@ -1,7 +1,8 @@
 import type { IVisitor } from '../livechat';
+import type { RoomType } from './RoomType';
+import type { FederationLookup } from '../federation';
 import type { IOmnichannelSource, IVisitorChannelInfo } from '../livechat/ILivechatRoom';
 import type { IUserLookup } from '../users';
-import type { RoomType } from './RoomType';
 
 /**
  * A lightweight representation of a room without resolving relational data.
@@ -40,4 +41,6 @@ export interface IRoomRaw {
 	visitor?: Pick<IVisitor, 'id' | 'token' | 'username' | 'name' | 'status' | 'activity'> & IVisitorChannelInfo;
 	departmentId?: string;
 	contactId?: string;
+	isFederated?: boolean;
+	federation?: FederationLookup;
 }

packages/apps-engine/src/definition/users/IUser.ts

@@ -1,3 +1,4 @@
+import type { FederationLookup } from '../federation';
 import type { IUserEmail } from './IUserEmail';
 import type { IUserSettings } from './IUserSettings';
 import type { UserStatusConnection } from './UserStatusConnection';
@@ -22,5 +23,7 @@ export interface IUser {
 	settings?: IUserSettings;
 	appId?: string;
 	sipExtension?: string;
+	isFederated?: boolean;
+	federation?: FederationLookup;
 	customFields?: { [key: string]: any };
 }