RocketChat/Rocket.Chat

import type { IMessageSearchProvider, IMessageSearchSuggestion, IRoom, IUser } from '@rocket.chat/core-typings';
import type { ServerMethods } from '@rocket.chat/ddp-client';
import { Meteor } from 'meteor/meteor';

import { SearchLogger } from './logger/logger';
import type { IRawSearchResult, ISearchResult } from './model/ISearchResult';
import { searchProviderService, validationService } from './service';

declare module '@rocket.chat/ddp-client' {
    // eslint-disable-next-line @typescript-eslint/naming-convention
    interface ServerMethods {
        'rocketchatSearch.getProvider'(): IMessageSearchProvider | undefined;
        'rocketchatSearch.search'(text: string, context: { uid?: IUser['_id']; rid: IRoom['_id'] }, payload: unknown): Promise<ISearchResult>;
        'rocketchatSearch.suggest'(
            text: string,
            context: { uid?: IUser['_id']; rid: IRoom['_id'] },
            payload: unknown,
        ): Promise<IMessageSearchSuggestion[]>;
    }
}

Meteor.methods<ServerMethods>({
    /**
     * Get the current provider with key, description, resultTemplate, suggestionItemTemplate and settings (as Map)
     */
    'rocketchatSearch.getProvider'() {
        const provider = searchProviderService.activeProvider;
        if (!provider) {
            return undefined;
        }

        return {
            key: provider.key,
            description: provider.i18nDescription,
            icon: provider.iconName,
            resultTemplate: provider.resultTemplate,
            supportsSuggestions: provider.supportsSuggestions,
            suggestionItemTemplate: provider.suggestionItemTemplate,
            settings: Object.fromEntries(Object.values(provider.settingsAsMap).map((setting) => [setting.key, setting.value] as const)),
        };
    },
    /**
     * Search using the current search provider and check if results are valid for the user. The search result has
     * the format `{messages:{start:0,numFound:1,docs:[{...}]},users:{...},rooms:{...}}`
     * @param text the search text
     * @param context the context (uid, rid)
     * @param payload custom payload (e.g. for paging)
     */
    async 'rocketchatSearch.search'(text, context, payload) {
        payload = payload !== null ? payload : undefined; // TODO is this cleanup necessary?

        if (!searchProviderService.activeProvider) {
            throw new Error('Provider currently not active');
        }

        SearchLogger.debug({ msg: 'search', text, context, payload });

        return new Promise<IRawSearchResult>((resolve, reject) => {
            searchProviderService.activeProvider?.search(text, context, payload, (error, data) => {
                if (error) {
                    return reject(error);
                }

                return resolve(data);
            });
        }).then((result) => validationService.validateSearchResult(result));
    },

    async 'rocketchatSearch.suggest'(text, context, payload) {
        payload ??= undefined; // TODO is this cleanup necessary?

        if (!searchProviderService.activeProvider) {
            throw new Error('Provider currently not active');
        }

        SearchLogger.debug({ msg: 'suggest', text, context, payload });

        return new Promise((resolve, reject) => {
            searchProviderService.activeProvider?.suggest(text, context, payload, (error, data) => {
                if (error) {
                    reject(error);
                    return;
                }

                resolve(data);
            });
        });
    },
});