Redirects

Custom redirect targets

Custom redirect targets (e.g., a news site) are supported via the customTargets-option. The option expects a block:

app.module.ts

RedirectsModule.register({
    customTargets: { news: NewsLinkBlock },
});

App.tsx

const RedirectsPage = createRedirectsPage({
    customTargets: { news: NewsLinkBlock },
});

A custom target URL service is required to resolve the target URLs:

my-redirect-target-url.service.ts

@Injectable({ scope: Scope.REQUEST })
export class MyRedirectTargetUrlService implements RedirectTargetUrlServiceInterface {
    constructor() {}

    async resolveTargetUrl(
        target: ExtractBlockData<RedirectsLinkBlock>["attachedBlocks"][number],
    ): Promise<string | undefined> {
        // Build the target URL here
    }
}

Full example

import { ExternalLinkBlock, ExtractBlockData } from "@comet/blocks-api";
import {
    InternalLinkBlock,
    PageTreeReadApiService,
    RedirectsLinkBlock,
    RedirectTargetUrlServiceInterface,
} from "@comet/cms-api";
import { InjectRepository } from "@mikro-orm/nestjs";
import { EntityRepository } from "@mikro-orm/postgresql";
import { Inject, Injectable, Scope } from "@nestjs/common";
import { Config } from "@src/config/config";
import { CONFIG } from "@src/config/config.module";
import { PredefinedPageType } from "@src/documents/predefined-pages/entities/predefined-page.entity";
import { PredefinedPagesService } from "@src/documents/predefined-pages/predefined-pages.service";
import { NewsLinkBlock } from "@src/news/blocks/news-link.block";
import { News } from "@src/news/entities/news.entity";
import { type PageTreeNodeScope } from "@src/page-tree/dto/page-tree-node-scope";

@Injectable({ scope: Scope.REQUEST })
export class MyRedirectTargetUrlService implements RedirectTargetUrlServiceInterface {
    constructor(
        private readonly pageTreeReadApi: PageTreeReadApiService,
        @Inject(CONFIG) private readonly config: Config,
        @InjectRepository(News) private readonly newsRepository: EntityRepository<News>,
        private readonly predefinedPagesService: PredefinedPagesService,
    ) {}

    async resolveTargetUrl(
        target: ExtractBlockData<RedirectsLinkBlock>["attachedBlocks"][number],
    ): Promise<string | undefined> {
        if (target.type === "internal") {
            const targetPageId = (target.props as ExtractBlockData<typeof InternalLinkBlock>)
                .targetPageId;
            if (targetPageId) {
                const targetPageNode = await this.pageTreeReadApi.getNode(targetPageId);

                if (!targetPageNode) {
                    return undefined;
                }

                const scope = targetPageNode.scope as PageTreeNodeScope;
                const baseUrl = this.getSiteUrl(scope);
                const path = await this.pageTreeReadApi.nodePath(targetPageNode);

                return `${baseUrl}/${scope.language}${path}`;
            }
        } else if (target.type === "external") {
            return (target.props as ExtractBlockData<typeof ExternalLinkBlock>).targetUrl;
        } else {
            const newsId = (target.props as ExtractBlockData<typeof NewsLinkBlock>).id;
            if (newsId) {
                const news = await this.newsRepository.findOne(newsId);

                if (!news) {
                    return undefined;
                }

                const scope = news.scope;
                const baseUrl = this.getSiteUrl(scope);
                const path = `${await this.predefinedPagesService.predefinedPagePath(
                    PredefinedPageType.News,
                    scope,
                )}/${news.slug}`;

                return `${baseUrl}/${scope.language}${path}`;
            }
        }
    }

    private getSiteUrl(scope: { domain: string }): string {
        const siteConfig = this.config.siteConfigs.find(
            (siteConfig) => siteConfig.scope.domain === scope.domain,
        );

        if (!siteConfig) {
            throw new Error(`Site config not found for domain: ${scope.domain}`);
        }

        return siteConfig.url;
    }
}

app.module.ts

RedirectsModule.register({
    customTargets: { news: NewsLinkBlock },
    TargetUrlService: MyRedirectTargetUrlService,
}),