clippr / backend / src / network / validator.ts

/*
 * clippr: a social bookmarking service for the AT Protocol
 * Copyright (c) 2025 clippr contributors.
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import {
	SocialClipprActorProfile,
	SocialClipprFeedClip,
	SocialClipprFeedTag,
} from "@clipprjs/lexicons";
import {
	isDatetime,
	isGenericUri,
	isLanguageCode,
} from "@atcute/lexicons/syntax";
import Logger from "../logger.js";
import { ComAtprotoRepoStrongRef } from "@atcute/atproto";
import { is } from "@atcute/lexicons";

export async function validateProfile(
	record: SocialClipprActorProfile.Main,
): Promise<boolean> {
	if (!isDatetime(record.createdAt)) {
		Logger.verbose(
			"Invalid createdAt timestamp for incoming profile record",
			record,
		);
		return false;
	}

	if (record.displayName) {
		if (record.displayName.length > 64) {
			Logger.verbose(
				"Too long displayName from incoming profile record",
				record,
			);
			return false;
		}

		if (record.displayName.length < 1) {
			Logger.verbose(
				"Too short displayName from incoming profile record",
				record,
			);
			return false;
		}
	} else {
		Logger.verbose("No displayName from incoming profile record", record);
		return false;
	}

	if (record.description) {
		if (record.description.length > 500) {
			Logger.verbose(
				"Too long description from incoming profile record",
				record,
			);
			return false;
		}

		if (record.description.length < 1) {
			Logger.verbose(
				"Too short description from incoming profile record",
				record,
			);
			return false;
		}
	}

	return true;
}

export async function validateTag(
	record: SocialClipprFeedTag.Main,
): Promise<boolean> {
	if (!isDatetime(record.createdAt)) {
		Logger.verbose(
			"Invalid createdAt timestamp for incoming tag record",
			record,
		);
		return false;
	}

	if (record.name.length > 64) {
		Logger.verbose("Name from incoming tag record is too long", record);
		return false;
	}

	if (record.color) {
		if (record.color.length > 7) {
			Logger.verbose("Color from incoming tag record is too long", record);
			return false;
		}

		if (!record.color.match("^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$")) {
			Logger.verbose(
				"Invalid hexadecimal color for incoming tag record",
				record,
			);
			return false;
		}
	}

	if (record.description) {
		if (record.description.length > 500) {
			Logger.verbose(
				"Description from incoming tag record is too long",
				record,
			);
			return false;
		}
	}

	return true;
}

export async function validateClip(
	record: SocialClipprFeedClip.Main,
): Promise<boolean> {
	if (!isGenericUri(record.url)) {
		Logger.verbose("Invalid url from incoming clip record", record);
		return false;
	}

	if (record.url.length > 2000) {
		Logger.verbose("Too long url from incoming clip record", record);
		return false;
	}

	if (record.title.length > 2048) {
		Logger.verbose("Too long title from incoming clip record", record);
		return false;
	}

	if (record.description.length > 4096) {
		Logger.verbose("Too long description from incoming clip record", record);
		return false;
	}

	if (record.notes) {
		if (record.notes.length > 10000) {
			Logger.verbose("Too long notes from incoming clip record", record);
			return false;
		}
	}

	if (record.tags) {
		if (
			record.tags.some((tag) => {
				return tag.$type !== "com.atproto.repo.strongRef";
			})
		) {
			Logger.verbose(
				"A tag from incoming clip record is not typed as strongRef",
				record,
			);
			return false;
		}

		if (
			record.tags.some((tag) => {
				return !is(ComAtprotoRepoStrongRef.mainSchema, tag);
			})
		) {
			Logger.verbose(
				"A tag from incoming clip record is not a valid strongRef",
				record,
			);
			return false;
		}

		// There should definitely be more tests here, but I'm not exactly sure what to add...
	}

	if (typeof record.unlisted !== "boolean") {
		Logger.verbose(
			"Unlisted value from incoming clip record is not a boolean",
			record,
		);
		return false;
	}

	// Same with "unread" but it's not required so

	if (record.languages) {
		if (record.languages.some((lang) => !isLanguageCode(lang))) {
			Logger.verbose(
				"An item in the incoming clip record's languages array is not a valid language code",
				record,
			);
			return false;
		}
	}

	if (!isDatetime(record.createdAt)) {
		Logger.verbose(
			"Invalid createdAt timestamp for incoming clip record",
			record,
		);
		return false;
	}

	return true;
}