mizzkey/packages/backend/src/models/Page.ts

/*
 * SPDX-FileCopyrightText: syuilo and misskey-project
 * SPDX-License-Identifier: AGPL-3.0-only
 */

import { Entity, Index, JoinColumn, Column, PrimaryColumn, ManyToOne } from 'typeorm';
import { id } from './util/id.js';
import { MiUser } from './User.js';
import { MiDriveFile } from './DriveFile.js';

@Entity('page')
@Index(['userId', 'name'], { unique: true })
export class MiPage {
	@PrimaryColumn(id())
	public id: string;

	@Index()
	@Column('timestamp with time zone', {
		comment: 'The updated date of the Page.',
	})
	public updatedAt: Date;

	@Column('varchar', {
		length: 256,
	})
	public title: string;

	@Index()
	@Column('varchar', {
		length: 256,
	})
	public name: string;

	@Column('varchar', {
		length: 256, nullable: true,
	})
	public summary: string | null;

	@Column('boolean')
	public alignCenter: boolean;

	@Column('boolean', {
		default: false,
	})
	public hideTitleWhenPinned: boolean;

	@Column('varchar', {
		length: 32,
	})
	public font: string;

	@Index()
	@Column({
		...id(),
		comment: 'The ID of author.',
	})
	public userId: MiUser['id'];

	@ManyToOne(type => MiUser, {
		onDelete: 'CASCADE',
	})
	@JoinColumn()
	public user: MiUser | null;

	@Column({
		...id(),
		nullable: true,
	})
	public eyeCatchingImageId: MiDriveFile['id'] | null;

	@ManyToOne(type => MiDriveFile, {
		onDelete: 'CASCADE',
	})
	@JoinColumn()
	public eyeCatchingImage: MiDriveFile | null;

	@Column('jsonb', {
		default: [],
	})
	public content: Record<string, any>[];

	@Column('jsonb', {
		default: [],
	})
	public variables: Record<string, any>[];

	@Column('varchar', {
		length: 16384,
		default: '',
	})
	public script: string;

	/**
	 * public ... 公開
	 * followers ... フォロワーのみ
	 * specified ... visibleUserIds で指定したユーザーのみ
	 */
	@Column('enum', { enum: ['public', 'followers', 'specified'] })
	public visibility: 'public' | 'followers' | 'specified';

	@Index()
	@Column({
		...id(),
		array: true, default: '{}',
	})
	public visibleUserIds: MiUser['id'][];

	@Column('integer', {
		default: 0,
	})
	public likedCount: number;

	constructor(data: Partial<MiPage>) {
		if (data == null) return;

		for (const [k, v] of Object.entries(data)) {
			(this as any)[k] = v;
		}
	}
}

export const pageNameSchema = { type: 'string', pattern: /^[a-zA-Z0-9_-]{1,256}$/.source } as const;

const blockBaseSchema = {
	type: 'object',
	properties: {
		id: { type: 'string', nullable: false },
		type: { type: 'string', nullable: false },
	},
	required: ['id', 'type'],
} as const;

const textBlockSchema = {
	type: 'object',
	properties: {
		...blockBaseSchema.properties,
		type: { type: 'string', nullable: false, enum: ['text'] },
		text: { type: 'string', nullable: false },
	},
	required: [
		...blockBaseSchema.required,
		'text',
	],
} as const;

const headingBlockSchema = {
	type: 'object',
	properties: {
		...blockBaseSchema.properties,
		type: { type: 'string', nullable: false, enum: ['heading'] },
		level: { type: 'number', nullable: false },
		text: { type: 'string', nullable: false },
	},
	required: [
		...blockBaseSchema.required,
		'level',
		'text',
	],
} as const;

const imageBlockSchema = {
	type: 'object',
	properties: {
		...blockBaseSchema.properties,
		type: { type: 'string', nullable: false, enum: ['image'] },
		fileId: { type: 'string', nullable: true },
	},
	required: [
		...blockBaseSchema.required,
		'fileId',
	],
} as const;

const noteBlockSchema = {
	type: 'object',
	properties: {
		...blockBaseSchema.properties,
		type: { type: 'string', nullable: false, enum: ['note']},
		detailed: { type: 'boolean', nullable: false },
		note: { type: 'string', format: 'misskey:id', nullable: true },
	},
	required: [
		...blockBaseSchema.required,
		'detailed',
	],
} as const;

/** @deprecated 要素を入れ子にする必要が（一旦）なくなったので非推奨。headingBlockを使用すること */
const sectionBlockSchema = {
	type: 'object',
	properties: {
		...blockBaseSchema.properties,
		type: { type: 'string', nullable: false, enum: ['section'] },
		title: { type: 'string', nullable: false },
		children: {
			type: 'array', nullable: false,
			items: {
				oneOf: [
					textBlockSchema,
					{ $ref: '#' },
					headingBlockSchema,
					imageBlockSchema,
					noteBlockSchema,
				],
			},
		},
	},
	required: [
		...blockBaseSchema.required,
		'title',
		'children',
	],
} as const;

export const pageBlockSchema = {
	type: 'object',
	oneOf: [
		textBlockSchema,
		sectionBlockSchema,
		headingBlockSchema,
		imageBlockSchema,
		noteBlockSchema,
	],
} as const;