@paperbits/core/ko/validation/validators.ts

Paperbits core components.

import * as ko from "knockout";
import * as validation from "knockout.validation";
import { ILayoutService } from "@paperbits/common/layouts/ILayoutService";
import { IPermalinkResolver, PermalinkService } from "@paperbits/common/permalinks";
import { RegExps } from "@paperbits/common";

const errorClassName = "is-invalid";

export class KnockoutValidation {
    constructor(
        private readonly permalinkService: PermalinkService,
        private readonly permalinkResolver: IPermalinkResolver,
        private readonly layoutService: ILayoutService,
        private readonly reservedPermalinks: string[]
    ) {
        validation.init({
            errorElementClass: errorClassName,
            decorateInputElement: true,
            insertMessages: false
        }, true);

        ko.extenders["onlyValid"] = (target, option) => {
            const resultObservable: any = ko.observable(target());

            target.subscribe((newValue) => {
                if (target.isValidating && target.isValidating()) {
                    const subscription = target.isValidating.subscribe(v => {
                        subscription.dispose();

                        if (target.isValid()) {
                            resultObservable(newValue);
                        }
                    });
                }
                else {
                    if (target.isValid()) {
                        resultObservable(newValue);
                    }
                }
            });

            return resultObservable;
        };

        validation.rules["isValidPermalink"] = {
            validator: (permalink: string): boolean => {
                if (!permalink) {
                    return false;
                }

                const isValidPermalink = RegExps.permalink.test(permalink);
                return isValidPermalink;
            },
            message: `Permalink is invalid. Use letters, numbers, dashes and slashes. Example: "/about/contacts"`
        };

        validation.rules["isPermalinkInUse"] = {
            async: true,
            validator: async (permalink: string, targetKey: string, callback: (valid: boolean) => void) => {
                if (!permalink) {
                    return false;
                }

                const permalinkContract = await this.permalinkService.getPermalink(permalink);
                const inUseByAnoterResource = !!permalinkContract && permalinkContract.targetKey !== targetKey;

                callback(!inUseByAnoterResource);
            },
            message: "This permalink is reserved or already in use."
        };

        validation.rules["isValidUrl"] = {
            validator: (permalink: string): boolean => {
                if (!permalink) {
                    return false;
                }

                const isValidUrl= RegExps.url.test(permalink);
                return isValidUrl;
            },
            message: `Permalink is invalid. Use letters, numbers, dashes and slashes. Example: "/about/contacts"`
        };

        validation.rules["uniqueLayoutUri"] = {
            async: true,
            validator: async (permalinkTemplate, layoutKey, callback: (isInUse: boolean) => void) => {
                if (!permalinkTemplate) {
                    callback(false);
                    return;
                }

                const layout = await this.layoutService.getLayoutByPermalinkTemplate(permalinkTemplate);
                const conflict = layout && layout.key !== layoutKey;

                callback(!conflict);
            },
            message: "This permalink template is already in use."
        };

        validation.registerExtenders();
    }
}