ministry-platform-provider/src/services/domainService.ts

TypeScript client library for Ministry Platform API integration

import { MinistryPlatformClient } from "../core/ministryPlatformClient.js";
import { DomainInfo, GlobalFilterItem, GlobalFilterParams, QueryParams } from "../Interfaces/mpProviderInterfaces.js";

export class DomainService {
    private client: MinistryPlatformClient;

    constructor(client: MinistryPlatformClient) {
        this.client = client;
    }

    /**
     * Returns the basic information about the current domain.
     * @returns Promise with the domain information
     */
    public async getDomainInfo(): Promise<DomainInfo> {
        try {
            await this.client.ensureValidToken();
            return await this.client.getHttpClient().get('/domain');
        } catch (error) {
            console.error('Error getting domain info:', error);
            throw error;
        }
    }

    /**
     * Returns the lookup values to be used as global filters. The key corresponds to
     * an identifier and the value corresponds to a friendly name (description). Zero (0)
     * identifier corresponds to records with not assigned filters.
     * @param params Optional parameters for the global filters request
     * @returns Promise with an array of global filter items
     */
    public async getGlobalFilters(params?: GlobalFilterParams): Promise<GlobalFilterItem[]> {
        try {
            await this.client.ensureValidToken();
            return await this.client.getHttpClient().get('/domain/filters', params as QueryParams);
        } catch (error) {
            console.error('Error getting global filters:', error);
            throw error;
        }
    }
}