chore: improve type definitions for login service configurations

apps/meteor/app/api/server/v1/settings.ts

@@ -1,14 +1,14 @@
-import type { ISetting, ISettingColor } from '@rocket.chat/core-typings';
+import type {
+	FacebookOAuthConfiguration,
+	ISetting,
+	ISettingColor,
+	TwitterOAuthConfiguration,
+	OAuthConfiguration,
+} from '@rocket.chat/core-typings';
 import { isSettingAction, isSettingColor } from '@rocket.chat/core-typings';
-import { Settings } from '@rocket.chat/models';
-import {
-	isOauthCustomConfiguration,
-	isSettingsUpdatePropDefault,
-	isSettingsUpdatePropsActions,
-	isSettingsUpdatePropsColor,
-} from '@rocket.chat/rest-typings';
+import { LoginServiceConfiguration as LoginServiceConfigurationModel, Settings } from '@rocket.chat/models';
+import { isSettingsUpdatePropDefault, isSettingsUpdatePropsActions, isSettingsUpdatePropsColor } from '@rocket.chat/rest-typings';
 import { Meteor } from 'meteor/meteor';
-import { ServiceConfiguration } from 'meteor/service-configuration';
 import type { FindOptions } from 'mongodb';
 import _ from 'underscore';
 
@@ -71,22 +71,25 @@ API.v1.addRoute(
 	{ authRequired: false },
 	{
 		async get() {
-			const oAuthServicesEnabled = await ServiceConfiguration.configurations.find({}, { fields: { secret: 0 } }).fetchAsync();
+			const oAuthServicesEnabled = await LoginServiceConfigurationModel.find({}, { projection: { secret: 0 } }).toArray();
 
 			return API.v1.success({
 				services: oAuthServicesEnabled.map((service) => {
-					if (!isOauthCustomConfiguration(service)) {
+					if (!service) {
 						return service;
 					}
 
-					if (service.custom || (service.service && ['saml', 'cas', 'wordpress'].includes(service.service))) {
+					if ((service as OAuthConfiguration).custom || (service.service && ['saml', 'cas', 'wordpress'].includes(service.service))) {
 						return { ...service };
 					}
 
 					return {
 						_id: service._id,
 						name: service.service,
-						clientId: service.appId || service.clientId || service.consumerKey,
+						clientId:
+							(service as FacebookOAuthConfiguration).appId ||
+							(service as OAuthConfiguration).clientId ||
+							(service as TwitterOAuthConfiguration).consumerKey,
 						buttonLabelText: service.buttonLabelText || '',
 						buttonColor: service.buttonColor || '',
 						buttonLabelColor: service.buttonLabelColor || '',
@@ -215,7 +218,7 @@ API.v1.addRoute(
 	{
 		async get() {
 			return API.v1.success({
-				configurations: await ServiceConfiguration.configurations.find({}, { fields: { secret: 0 } }).fetchAsync(),
+				configurations: await LoginServiceConfigurationModel.find({}, { projection: { secret: 0 } }).toArray(),
 			});
 		},
 	},

apps/meteor/client/startup/customOAuth.ts

@@ -1,3 +1,4 @@
+import type { ILoginServiceConfiguration, OAuthConfiguration } from '@rocket.chat/core-typings';
 import { Meteor } from 'meteor/meteor';
 import { ServiceConfiguration } from 'meteor/service-configuration';
 
@@ -10,15 +11,16 @@ Meteor.startup(() => {
 		})
 		.observe({
 			async added(record) {
-				const { isOauthCustomConfiguration } = await import('@rocket.chat/rest-typings');
-				if (!isOauthCustomConfiguration(record)) {
+				const service = record as unknown as (ILoginServiceConfiguration & OAuthConfiguration) | undefined;
+
+				if (!service) {
 					return;
 				}
 
-				new CustomOAuth(record.service, {
-					serverURL: record.serverURL,
-					authorizePath: record.authorizePath,
-					scope: record.scope,
+				new CustomOAuth(service.service, {
+					serverURL: service.serverURL,
+					authorizePath: service.authorizePath,
+					scope: service.scope,
 				});
 			},
 		});

apps/meteor/server/models/raw/LoginServiceConfiguration.ts

@@ -1,11 +1,11 @@
-import type { ILoginServiceConfiguration, RocketChatRecordDeleted } from '@rocket.chat/core-typings';
+import type { LoginServiceConfiguration, RocketChatRecordDeleted } from '@rocket.chat/core-typings';
 import type { ILoginServiceConfigurationModel } from '@rocket.chat/model-typings';
 import type { Collection, Db } from 'mongodb';
 
 import { BaseRaw } from './BaseRaw';
 
-export class LoginServiceConfigurationRaw extends BaseRaw<ILoginServiceConfiguration> implements ILoginServiceConfigurationModel {
-	constructor(db: Db, trash?: Collection<RocketChatRecordDeleted<ILoginServiceConfiguration>>) {
+export class LoginServiceConfigurationRaw extends BaseRaw<LoginServiceConfiguration> implements ILoginServiceConfigurationModel {
+	constructor(db: Db, trash?: Collection<RocketChatRecordDeleted<LoginServiceConfiguration>>) {
 		super(db, 'meteor_accounts_loginServiceConfiguration', trash, {
 			preventSetUpdatedAt: true,
 			collectionNameResolver(name) {

apps/meteor/server/services/meteor/service.ts

@@ -1,10 +1,9 @@
 import { api, ServiceClassInternal, listenToMessageSentEvent } from '@rocket.chat/core-services';
 import type { AutoUpdateRecord, IMeteor } from '@rocket.chat/core-services';
-import type { ILivechatAgent, UserStatus } from '@rocket.chat/core-typings';
-import { Users } from '@rocket.chat/models';
+import type { ILivechatAgent, LoginServiceConfiguration, UserStatus } from '@rocket.chat/core-typings';
+import { LoginServiceConfiguration as LoginServiceConfigurationModel, Users } from '@rocket.chat/models';
 import { Meteor } from 'meteor/meteor';
 import { MongoInternals } from 'meteor/mongo';
-import { ServiceConfiguration } from 'meteor/service-configuration';
 
 import { triggerHandler } from '../../../app/integrations/server/lib/triggerHandler';
 import { Livechat } from '../../../app/livechat/server/lib/LivechatTyped';
@@ -258,8 +257,8 @@ export class MeteorService extends ServiceClassInternal implements IMeteor {
 		return Object.fromEntries(clientVersionsStore);
 	}
 
-	async getLoginServiceConfiguration(): Promise<any[]> {
-		return ServiceConfiguration.configurations.find({}, { fields: { secret: 0 } }).fetchAsync();
+	async getLoginServiceConfiguration(): Promise<LoginServiceConfiguration[]> {
+		return LoginServiceConfigurationModel.find({}, { projection: { secret: 0 } }).toArray();
 	}
 
 	async callMethodWithToken(userId: string, token: string, method: string, args: any[]): Promise<void | any> {

packages/core-services/src/types/IMeteor.ts

@@ -1,3 +1,5 @@
+import type { LoginServiceConfiguration } from '@rocket.chat/core-typings';
+
 import type { IServiceClass } from './ServiceClass';
 
 export type AutoUpdateRecord = {
@@ -14,7 +16,7 @@ export type AutoUpdateRecord = {
 };
 export interface IMeteor extends IServiceClass {
 	getAutoUpdateClientVersions(): Promise<Record<string, AutoUpdateRecord>>;
-	getLoginServiceConfiguration(): Promise<any[]>;
+	getLoginServiceConfiguration(): Promise<LoginServiceConfiguration[]>;
 	callMethodWithToken(userId: string | undefined, token: string | undefined, method: string, args: any[]): Promise<void | any>;
 	notifyGuestStatusChanged(token: string, status: string): Promise<void>;
 	getURL(path: string, params?: Record<string, any>, cloudDeepLinkUrl?: string): Promise<string>;

packages/core-typings/src/ILoginServiceConfiguration.ts

@@ -1,6 +1,113 @@
 export interface ILoginServiceConfiguration {
 	_id: string;
 	service: string;
+}
+
+export type OAuthConfiguration = {
+	custom: boolean;
 	clientId: string;
 	secret: string;
-}
+	serverURL: string;
+	tokenPath: string;
+	identityPath: string;
+	authorizePath: string;
+	scope: string;
+	accessTokenParam: string;
+	buttonLabelText: string;
+	buttonLabelColor: string;
+	loginStyle: '' | 'redirect' | 'popup';
+	buttonColor: string;
+	tokenSentVia: 'header' | 'payload';
+	identityTokenSentVia: 'default' | 'header' | 'payload';
+	keyField: 'username' | 'email';
+	usernameField: string;
+	emailField: string;
+	nameField: string;
+	avatarField: string;
+	rolesClaim: string;
+	groupsClaim: string;
+	channelsMap: string;
+	channelsAdmin: string;
+	mergeUsers: boolean;
+	mergeUsersDistinctServices: boolean;
+	mapChannels: boolean;
+	mergeRoles: boolean;
+	rolesToSync: string;
+	showButton: boolean;
+};
+
+export type FacebookOAuthConfiguration = Omit<Partial<OAuthConfiguration>, 'clientId'> & {
+	appId: OAuthConfiguration['clientId'];
+};
+
+export type TwitterOAuthConfiguration = Omit<Partial<OAuthConfiguration>, 'clientId'> & {
+	consumerKey: OAuthConfiguration['clientId'];
+};
+
+export type LinkedinOAuthConfiguration = Partial<OAuthConfiguration> & {
+	clientConfig: {
+		requestPermissions?: string[];
+	};
+};
+
+export type CASConfiguration = {
+	enabled: boolean;
+	base_url: string;
+	login_url: string;
+	buttonLabelText: string;
+	buttonLabelColor: string;
+	buttonColor: string;
+	width: number;
+	height: number;
+	autoclose: boolean;
+};
+
+export type SAMLConfiguration = {
+	buttonLabelText: string;
+	buttonLabelColor: string;
+	buttonColor: string;
+	clientConfig: {
+		provider?: string;
+	};
+	entryPoint: string;
+	idpSLORedirectURL: string;
+	usernameNormalize: 'None' | 'Lowercase';
+	immutableProperty: 'Username' | 'EMail';
+	generateUsername: boolean;
+	debug: boolean;
+	nameOverwrite: boolean;
+	mailOverwrite: boolean;
+	issuer: string;
+	logoutBehaviour: 'SAML' | 'Local';
+	defaultUserRole: string;
+	secret: {
+		privateKey: string;
+		publicCert: string;
+		cert: string;
+	};
+	signatureValidationType: 'All' | 'Response' | 'Assertion' | 'Either';
+	userDataFieldMap: string;
+	allowedClockDrift: number;
+	channelsAttributeUpdate: boolean;
+	includePrivateChannelsInUpdate: boolean;
+	customAuthnContext: string;
+	authnContextComparison: 'better' | 'exact' | 'maximum' | 'minimum';
+	identifierFormat: string;
+	nameIDPolicyTemplate: string;
+	authnContextTemplate: string;
+	authRequestTemplate: string;
+	logoutResponseTemplate: string;
+	logoutRequestTemplate: string;
+	metadataCertificateTemplate: string;
+	metadataTemplate: string;
+};
+
+export type LoginServiceConfiguration = ILoginServiceConfiguration &
+	(
+		| Partial<OAuthConfiguration>
+		| Partial<FacebookOAuthConfiguration>
+		| Partial<TwitterOAuthConfiguration>
+		| Partial<LinkedinOAuthConfiguration>
+		| Partial<CASConfiguration>
+		| Partial<SAMLConfiguration>
+	);

packages/model-typings/src/models/ILoginServiceConfigurationModel.ts

@@ -1,8 +1,8 @@
-import type { ILoginServiceConfiguration } from '@rocket.chat/core-typings';
+import type { LoginServiceConfiguration } from '@rocket.chat/core-typings';
 
 import type { IBaseModel } from './IBaseModel';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface ILoginServiceConfigurationModel extends IBaseModel<ILoginServiceConfiguration> {
+export interface ILoginServiceConfigurationModel extends IBaseModel<LoginServiceConfiguration> {
 	//
 }

packages/rest-typings/src/v1/settings.ts

@@ -1,4 +1,4 @@
-import type { ISetting, ISettingColor } from '@rocket.chat/core-typings';
+import type { ISetting, ISettingColor, LoginServiceConfiguration } from '@rocket.chat/core-typings';
 
 import type { PaginatedResult } from '../helpers/PaginatedResult';
 
@@ -8,46 +8,6 @@ type SettingsUpdatePropsActions = {
 	execute: boolean;
 };
 
-export type OauthCustomConfiguration = {
-	_id: string;
-	clientId?: string;
-	custom: boolean;
-	service?: string;
-	serverURL: string;
-	tokenPath: string;
-	identityPath: string;
-	authorizePath: string;
-	scope: string;
-	loginStyle: 'popup' | 'redirect';
-	tokenSentVia: 'header' | 'payload';
-	identityTokenSentVia: 'default' | 'header' | 'payload';
-	keyField: 'username' | 'email';
-	usernameField: string;
-	emailField: string;
-	nameField: string;
-	avatarField: string;
-	rolesClaim: string;
-	groupsClaim: string;
-	mapChannels: string;
-	channelsMap: string;
-	channelsAdmin: string;
-	mergeUsers: boolean;
-	mergeUsersDistinctServices: boolean;
-	mergeRoles: boolean;
-	accessTokenParam: string;
-	showButton: boolean;
-
-	appId: string;
-	consumerKey?: string;
-
-	clientConfig: unknown;
-	buttonLabelText: string;
-	buttonLabelColor: string;
-	buttonColor: string;
-};
-
-export const isOauthCustomConfiguration = (config: any): config is OauthCustomConfiguration => Boolean(config);
-
 export const isSettingsUpdatePropsActions = (props: Partial<SettingsUpdateProps>): props is SettingsUpdatePropsActions =>
 	'execute' in props;
 
@@ -74,7 +34,7 @@ export type SettingsEndpoints = {
 
 	'/v1/settings.oauth': {
 		GET: () => {
-			services: Partial<OauthCustomConfiguration>[];
+			services: Partial<LoginServiceConfiguration>[];
 		};
 	};
 
@@ -95,10 +55,7 @@ export type SettingsEndpoints = {
 
 	'/v1/service.configurations': {
 		GET: () => {
-			configurations: Array<{
-				appId: string;
-				secret: string;
-			}>;
+			configurations: Array<LoginServiceConfiguration>;
 		};
 	};
 };