@paperbits/common/permalinks/permalinkResolver.ts

Paperbits common components.

import { IPermalinkResolver } from "./";
import { HyperlinkContract } from "../editing";
import { HyperlinkModel } from "./hyperlinkModel";
import { Contract } from "..";
import { ContentItemContract } from "../contentModel";
import { NavigationTarget } from "../html";

export class PermalinkResolver implements IPermalinkResolver {
    constructor(private readonly permalinkResolvers: IPermalinkResolver[]) { }

    public canHandleTarget(targetKey: string): boolean {
        if (!targetKey) {
            throw new Error(`Parameter "targetKey" not specified.`);
        }

        return this.permalinkResolvers.some(x => x.canHandleTarget(targetKey));
    }

    public async getUrlByTargetKey(targetKey: string, locale?: string): Promise<string> {
        if (!targetKey) {
            throw new Error(`Parameter "targetKey" not specified.`);
        }

        let targetUrl: string = null;

        const permalinkResolver = this.permalinkResolvers.find(x => x.canHandleTarget(targetKey));

        if (!permalinkResolver) {
            console.warn(`Could not find permalink resolver for target key ${targetKey}.`);
            return targetKey;
        }

        try {
            targetUrl = await permalinkResolver.getUrlByTargetKey(targetKey, locale);
        }
        catch (error) {
            console.warn(`Unable to resolve permalink. ${error.stack || error.message}`);
        }

        return targetUrl;
    }

    public async getHyperlinkFromContract(hyperlinkContract: HyperlinkContract, locale?: string): Promise<HyperlinkModel> {
        let hyperlinkModel: HyperlinkModel;

        if (!hyperlinkContract.targetKey) {
            return this.getEmptyHyperlink();
        }

        const permalinkResolver = this.permalinkResolvers.find(x => x.canHandleTarget(hyperlinkContract.targetKey));

        if (!permalinkResolver) {
            console.warn(`Could not find permalink resolver for target key "${hyperlinkContract.targetKey}"`);
            return this.getEmptyHyperlink();
        }

        hyperlinkModel = await permalinkResolver.getHyperlinkFromContract(hyperlinkContract, locale);

        if (hyperlinkModel) {
            return hyperlinkModel;
        }

        return this.getEmptyHyperlink();
    }

    public async getHyperlinkByTargetKey(targetKey: string, locale?: string): Promise<HyperlinkModel> {
        const permalinkResolver = this.permalinkResolvers.find(x => x.canHandleTarget(targetKey));

        if (!permalinkResolver) {
            console.warn(`Could not find permalink resolver for content item with key "${targetKey}".`);
            return this.getEmptyHyperlink();
        }

        const hyperlink = await permalinkResolver.getHyperlinkByTargetKey(targetKey, locale);

        return hyperlink || this.getEmptyHyperlink();
    }

    public async getContentByPermalink(permalink: string, locale?: string): Promise<Contract> {
        for (const permalinkResolver of this.permalinkResolvers) {
            if (!permalinkResolver.getContentByPermalink) {
                continue;
            }

            const contentItem = await permalinkResolver?.getContentByPermalink(permalink, locale);

            if (contentItem) {
                return contentItem;
            }
        }

        return null;
    }

    public async getContentItemByPermalink(permalink: string, locale?: string): Promise<ContentItemContract> {
        for (const permalinkResolver of this.permalinkResolvers) {
            if (!permalinkResolver.getContentItemByPermalink) {
                continue;
            }

            const contentItem = await permalinkResolver?.getContentItemByPermalink(permalink, locale);

            if (contentItem) {
                return contentItem;
            }
        }

        return null;
    }

    public getEmptyHyperlink(): HyperlinkModel {
        const hyperlinkModel = new HyperlinkModel();
        hyperlinkModel.title = "Unset link";
        hyperlinkModel.target = NavigationTarget.Self;
        hyperlinkModel.targetKey = null;
        hyperlinkModel.href = "#";
        hyperlinkModel.anchor = null;
        hyperlinkModel.anchorName = null;
        return hyperlinkModel;
    }
}