@coffic/cosy-ui 0.5.8 → 0.5.12

package/dist/entities/BaseDoc.ts

@@ -0,0 +1,170 @@
+import { render, type RenderResult, type CollectionEntry, type DataEntryMap } from 'astro:content';
+import { SidebarItemEntity, type SidebarProvider } from './SidebarItem';
+import { logger } from '../utils/logger';
+
+/**
+ * 文档基类，提供所有文档类型共享的基本功能
+ */
+export abstract class BaseDoc<
+	Collection extends keyof DataEntryMap,
+	T extends CollectionEntry<Collection>,
+> implements SidebarProvider
+{
+	protected entry: T;
+
+	constructor(entry: T) {
+		this.entry = entry;
+	}
+
+	/**
+	 * 获取文档ID
+	 */
+	getId(): string {
+		return this.entry.id;
+	}
+
+	/**
+	 * 获取文档标题
+	 */
+	getTitle(): string {
+		return this.entry.data.title as string;
+	}
+
+	/**
+	 * 获取文档语言
+	 */
+	getLang(): string {
+		return this.entry.id.split('/')[0];
+	}
+
+	/**
+	 * 获取文档slug
+	 */
+	getSlug(): string {
+		return this.getId().split('/').slice(1).join('/');
+	}
+
+	/**
+	 * 获取文档描述
+	 */
+	getDescription(): string {
+		return this.entry.data.description as string;
+	}
+
+	/**
+	 * 获取文档链接
+	 * 每个子类必须实现此方法以提供正确的链接
+	 */
+	abstract getLink(): string;
+
+	/**
+	 * 渲染文档内容
+	 */
+	async render(): Promise<RenderResult> {
+		return await render(this.entry);
+	}
+
+	/**
+	 * 获取文档的层级深度
+	 * 例如：对于 ID 为 "zh-cn/blog/typescript" 的文档，深度为3
+	 */
+	getLevel(): number {
+		return this.entry.id.split('/').length;
+	}
+
+	/**
+	 * 转换为侧边栏项目
+	 * 基本实现，只包含当前文档
+	 */
+	async toSidebarItem(): Promise<SidebarItemEntity> {
+		return new SidebarItemEntity({
+			text: this.getTitle(),
+			link: this.getLink(),
+		});
+	}
+}
+
+/**
+ * 层级文档基类，为有层级结构的文档类型提供额外功能
+ * 例如课程等有父子关系的文档
+ */
+export abstract class HierarchicalDoc<
+	Collection extends keyof DataEntryMap,
+	T extends CollectionEntry<Collection>,
+> extends BaseDoc<Collection, T> {
+	/**
+	 * 获取父文档ID
+	 * 例如：对于 ID 为 "zh-cn/blog/typescript" 的文档，父ID为 "zh-cn/blog"
+	 *
+	 * @returns 父文档ID，如果没有父文档则返回null
+	 */
+	getParentId(): string | null {
+		const parts = this.entry.id.split('/');
+		return parts.length > 1 ? parts.slice(0, -1).join('/') : null;
+	}
+
+	/**
+	 * 获取顶级文档的ID
+	 * 例如：对于 ID 为 "zh-cn/blog/typescript" 的文档，顶级ID为 "zh-cn/blog"
+	 *
+	 * 默认实现假设顶级ID是前两部分
+	 * 子类可以根据需要覆盖此方法
+	 */
+	async getTopDocId(): Promise<string> {
+		const id = this.entry.id;
+		const parts = id.split('/');
+		return parts[0] + '/' + parts[1];
+	}
+
+	/**
+	 * 获取顶级文档
+	 * 子类应该实现此方法以提供正确的顶级文档
+	 */
+	abstract getTopDoc(): Promise<HierarchicalDoc<Collection, T> | null>;
+
+	/**
+	 * 获取子文档
+	 * 子类应该实现此方法以提供正确的子文档列表
+	 */
+	abstract getChildren(): Promise<HierarchicalDoc<Collection, T>[]>;
+
+	/**
+	 * 转换为侧边栏项目
+	 * 如果文档有子文档，会包含子文档的侧边栏项目
+	 */
+	override async toSidebarItem(): Promise<SidebarItemEntity> {
+		const debug = false;
+
+		const children = await this.getChildren();
+		const childItems = await Promise.all(children.map((child) => child.toSidebarItem()));
+
+		if (debug) {
+			logger.info(`${this.entry.id} 的侧边栏项目`);
+			console.log(childItems);
+		}
+
+		return new SidebarItemEntity({
+			text: this.getTitle(),
+			items: childItems,
+			link: this.getLink(),
+		});
+	}
+
+	/**
+	 * 获取顶级侧边栏项目
+	 * 如果有顶级文档，返回顶级文档的侧边栏项目
+	 * 否则返回当前文档的侧边栏项目
+	 */
+	async getTopSidebarItem(): Promise<SidebarItemEntity> {
+		const topDoc = await this.getTopDoc();
+		if (topDoc) {
+			return await topDoc.toSidebarItem();
+		}
+
+		return new SidebarItemEntity({
+			text: this.getTitle(),
+			items: [],
+			link: this.getLink(),
+		});
+	}
+}

package/dist/entities/BlogDoc.ts

@@ -0,0 +1,53 @@
+import type { BlogEntry } from '../database/BlogDB';
+import { LinkUtil } from '../utils/link';
+import Tag from './Tag';
+import { BaseDoc } from './BaseDoc';
+import { COLLECTION_NAME } from '../database/BlogDB';
+
+export default class BlogDoc extends BaseDoc<typeof COLLECTION_NAME, BlogEntry> {
+	private constructor(entry: BlogEntry) {
+		super(entry);
+	}
+
+	static fromEntry(entry: BlogEntry) {
+		return new BlogDoc(entry);
+	}
+
+	getLink(): string {
+		return LinkUtil.getBlogLink(this.entry.id, this.getLang());
+	}
+
+	getTags(): Tag[] {
+		const tags = this.entry.data.tags as string[];
+
+		if (!tags || tags.length === 0) {
+			return [];
+		}
+
+		return tags.map((tag) => new Tag(tag, 0, this.getLang()));
+	}
+
+	getDate(): Date {
+		return new Date(this.entry.data.date as Date);
+	}
+
+	getDateForDisplay() {
+		try {
+			const dateObj = new Date(this.entry.data.date as Date);
+
+			// Check if date is valid
+			if (isNaN(dateObj.getTime())) {
+				console.warn(`Invalid date format: ${this.entry.data.date}`);
+				return 'Date unavailable: ' + this.getTitle() + ' ' + this.getLink();
+			}
+			return dateObj.toLocaleDateString('zh-CN', {
+				year: 'numeric',
+				month: 'long',
+				day: 'numeric',
+			});
+		} catch (error) {
+			console.error(`Error formatting date: ${this.entry.data.date}`, error);
+			return 'Date unavailable';
+		}
+	}
+}

package/dist/entities/CourseDoc.ts

@@ -0,0 +1,56 @@
+import { logger } from '@/utils/logger';
+import { SidebarItemEntity } from './SidebarItem';
+import type { CourseEntry } from '../database/CourseDB';
+import courseDB from '../database/CourseDB';
+import { LinkUtil } from '../utils/link';
+import { HierarchicalDoc } from './BaseDoc';
+import { COLLECTION_NAME } from '../database/CourseDB';
+
+export default class CourseDoc extends HierarchicalDoc<typeof COLLECTION_NAME, CourseEntry> {
+	constructor(entry: CourseEntry) {
+		super(entry);
+	}
+
+	static fromEntry(entry: CourseEntry) {
+		return new CourseDoc(entry);
+	}
+
+	getLink(): string {
+		return LinkUtil.getCourseLink(this.entry.id);
+	}
+
+	async getTopDoc(): Promise<CourseDoc | null> {
+		const id = await this.getTopDocId();
+		const doc = await courseDB.find(id);
+		return doc;
+	}
+
+	async getChildren(): Promise<CourseDoc[]> {
+		return await courseDB.getChildren(this.entry.id);
+	}
+
+	override async toSidebarItem(): Promise<SidebarItemEntity> {
+		const debug = false;
+		const children = await this.getChildren();
+		let childItems = await Promise.all(children.map((child) => child.toSidebarItem()));
+
+		if (this.isBook()) {
+			childItems = [...childItems];
+		}
+
+		if (debug) {
+			logger.info(`${this.entry.id} 的侧边栏项目`);
+			console.log(childItems);
+		}
+
+		return new SidebarItemEntity({
+			text: this.getTitle(),
+			items: childItems,
+			link: this.getLink(),
+		});
+	}
+
+	isBook(): boolean {
+		return this.entry.id.split('/').length === 2;
+	}
+}

package/dist/entities/ExperimentDoc.ts

@@ -0,0 +1,117 @@
+import type { ExperimentEntry } from '../database/ExperimentDB';
+import experimentDB from '../database/ExperimentDB';
+import { logger } from '../utils/logger';
+import { SidebarItemEntity } from './SidebarItem';
+import type { Heading } from './Heading';
+import { LinkUtil } from '../utils/link';
+import { HierarchicalDoc } from './BaseDoc';
+import { COLLECTION_NAME } from '../database/ExperimentDB';
+
+export default class ExperimentDoc extends HierarchicalDoc<
+	typeof COLLECTION_NAME,
+	ExperimentEntry
+> {
+	constructor(entry: ExperimentEntry) {
+		super(entry);
+	}
+
+	isBook(): boolean {
+		return this.entry.id.split('/').length === 2;
+	}
+
+	async getBookId(): Promise<string> {
+		return await this.getTopDocId();
+	}
+
+	async getBook(): Promise<ExperimentDoc | null> {
+		const bookId = await this.getBookId();
+		return await experimentDB.find(bookId);
+	}
+
+	getLink(): string {
+		const debug = false;
+		const lang = this.getLang();
+		const link = LinkUtil.getExperimentLink(lang, this.getId());
+
+		if (debug) {
+			logger.info(`获取 ${this.entry.id} 的链接: ${link}`);
+		}
+
+		return link;
+	}
+
+	/**
+	 * 获取文档的语言
+	 *
+	 * 文档的 id 格式为 `book-id/zh-cn/chapter-id/lesson-id`
+	 *
+	 * @returns 语言
+	 */
+	override getLang(): string {
+		const debug = false;
+
+		const parts = this.entry.id.split('/');
+		const lang = parts[1];
+
+		if (debug) {
+			logger.info(`获取 ${this.entry.id} 的语言: ${lang}`);
+		}
+
+		return lang;
+	}
+
+	getHTML(): string {
+		const debug = false;
+
+		if (debug) {
+			logger.info(`获取 ${this.entry.id} 的 HTML`);
+		}
+
+		return this.entry.rendered?.html || '';
+	}
+
+	getHeadings(): Heading[] {
+		const debug = false;
+
+		if (debug) {
+			logger.info(`获取 ${this.entry.id} 的 headings`);
+		}
+
+		return (this.entry.rendered?.metadata?.headings as Heading[]) || [];
+	}
+
+	async getTopDoc(): Promise<ExperimentDoc | null> {
+		const bookId = await this.getBookId();
+		return await experimentDB.find(bookId);
+	}
+
+	async getChildren(): Promise<ExperimentDoc[]> {
+		return await experimentDB.getChildren(this.entry.id);
+	}
+
+	async getDescendants(): Promise<ExperimentDoc[]> {
+		return await experimentDB.getDescendantDocs(this.entry.id);
+	}
+
+	override async toSidebarItem(): Promise<SidebarItemEntity> {
+		const debug = false;
+
+		const children = await this.getChildren();
+		let childItems = await Promise.all(children.map((child) => child.toSidebarItem()));
+
+		if (this.isBook()) {
+			childItems = [...childItems];
+		}
+
+		if (debug) {
+			logger.info(`${this.entry.id} 的侧边栏项目`);
+			console.log(childItems);
+		}
+
+		return new SidebarItemEntity({
+			text: this.getTitle(),
+			items: childItems,
+			link: this.getLink(),
+		});
+	}
+}

package/dist/entities/Heading.ts

@@ -0,0 +1,13 @@
+/**
+ * 表示文档中的标题结构
+ */
+export interface Heading {
+    /** 标题深度，如 h1=1, h2=2, h3=3 等 */
+    depth: number;
+
+    /** 标题的唯一标识符，用于锚点链接 */
+    slug: string;
+
+    /** 标题文本内容 */
+    text: string;
+} 

package/dist/entities/LessonDoc.ts

@@ -0,0 +1,114 @@
+import type { LessonEntry } from '../database/LessonDB';
+import lessonDB from '../database/LessonDB';
+import { logger } from '../utils/logger';
+import { SidebarItemEntity } from './SidebarItem';
+import type { Heading } from './Heading';
+import { LinkUtil } from '../utils/link';
+import { HierarchicalDoc } from './BaseDoc';
+import { COLLECTION_NAME } from '../database/LessonDB';
+
+export default class LessonDoc extends HierarchicalDoc<typeof COLLECTION_NAME, LessonEntry> {
+	constructor(entry: LessonEntry) {
+		super(entry);
+	}
+
+	isBook(): boolean {
+		return this.entry.id.split('/').length === 2;
+	}
+
+	async getBookId(): Promise<string> {
+		return await this.getTopDocId();
+	}
+
+	async getBook(): Promise<LessonDoc | null> {
+		const bookId = await this.getBookId();
+		return await lessonDB.find(bookId);
+	}
+
+	getLink(): string {
+		const debug = false;
+		const lang = this.getLang();
+		const link = LinkUtil.getLessonLink(lang, this.getId());
+
+		if (debug) {
+			logger.info(`获取 ${this.entry.id} 的链接: ${link}`);
+		}
+
+		return link;
+	}
+
+	/**
+	 * 获取文档的语言
+	 *
+	 * 文档的 id 格式为 `book-id/zh-cn/chapter-id/lesson-id`
+	 *
+	 * @returns 语言
+	 */
+	override getLang(): string {
+		const debug = false;
+
+		const parts = this.entry.id.split('/');
+		const lang = parts[1];
+
+		if (debug) {
+			logger.info(`获取 ${this.entry.id} 的语言: ${lang}`);
+		}
+
+		return lang;
+	}
+
+	getHTML(): string {
+		const debug = false;
+
+		if (debug) {
+			logger.info(`获取 ${this.entry.id} 的 HTML`);
+		}
+
+		return this.entry.rendered?.html || '';
+	}
+
+	getHeadings(): Heading[] {
+		const debug = false;
+
+		if (debug) {
+			logger.info(`获取 ${this.entry.id} 的 headings`);
+		}
+
+		return (this.entry.rendered?.metadata?.headings as Heading[]) || [];
+	}
+
+	async getTopDoc(): Promise<LessonDoc | null> {
+		const bookId = await this.getBookId();
+		return await lessonDB.find(bookId);
+	}
+
+	async getChildren(): Promise<LessonDoc[]> {
+		return await lessonDB.getChildren(this.entry.id);
+	}
+
+	async getDescendants(): Promise<LessonDoc[]> {
+		return await lessonDB.getDescendantDocs(this.entry.id);
+	}
+
+	override async toSidebarItem(): Promise<SidebarItemEntity> {
+		const debug = false;
+
+		const children = await this.getChildren();
+		let childItems = await Promise.all(children.map((child) => child.toSidebarItem()));
+
+		if (this.isBook()) {
+			childItems = [...childItems];
+		}
+
+		if (debug) {
+			logger.info(`${this.entry.id} 的侧边栏项目`);
+			console.log(childItems);
+		}
+
+		return new SidebarItemEntity({
+			text: this.getTitle(),
+			items: childItems,
+			link: this.getLink(),
+		});
+	}
+}

package/dist/entities/MetaDoc.ts

@@ -0,0 +1,82 @@
+import { SidebarItem } from './SidebarItem';
+import type { MetaEntry } from '../database/MetaDB';
+import { LinkUtil } from '../utils/link';
+import { BaseDoc } from './BaseDoc';
+import metaDB from '../database/MetaDB';
+import { COLLECTION_NAME } from '../database/MetaDB';
+
+export default class MetaDoc extends BaseDoc<typeof COLLECTION_NAME, MetaEntry> {
+	constructor(entry: MetaEntry) {
+		super(entry);
+	}
+
+	static fromEntry(entry: MetaEntry) {
+		return new MetaDoc(entry);
+	}
+
+	getLink(): string {
+		return LinkUtil.getMetaLink(this.getLang(), this.getSlug());
+	}
+
+	getLang(): string {
+		return this.entry.id.split('/')[0];
+	}
+
+	/**
+	 * 获取元数据页面的 slug
+	 * 例如：
+	 *  ID: zh-cn/about 的 slug 为 about
+	 *  ID: en/privacy 的 slug 为 privacy
+	 */
+	override getSlug(): string {
+		// 从 ID 中获取 slug，即删除以/分割后的第一个元素
+		return this.getId().split('/').slice(1).join('/');
+	}
+
+	/**
+	 * 获取兄弟文档
+	 * 例如：对于 'zh-cn/about'，会返回 'zh-cn' 下的其他文档
+	 */
+	async getSiblingDocs(): Promise<MetaDoc[]> {
+		return await metaDB.getSiblings(this.entry.id);
+	}
+
+	/**
+	 * 获取兄弟文档的侧边栏项目
+	 */
+	async getSiblingSidebarItems(): Promise<SidebarItem[]> {
+		const siblings = await this.getSiblingDocs();
+		const siblingItems = await Promise.all(
+			siblings.map((sibling) => {
+				return new SidebarItem({
+					label: sibling.getTitle(),
+					link: sibling.getLink(),
+				});
+			})
+		);
+		return siblingItems;
+	}
+
+	/**
+	 * 重写侧边栏项目方法
+	 * 对于元数据页面，我们不显示子项目
+	 */
+	override async toSidebarItem(): Promise<SidebarItem> {
+		return new SidebarItem({
+			label: this.getTitle(),
+			link: this.getLink(),
+		});
+	}
+
+	/**
+	 * 重写顶级侧边栏项目方法
+	 * 对于元数据页面，我们显示所有兄弟页面作为侧边栏项目
+	 */
+	async getTopSidebarItem(): Promise<SidebarItem> {
+		return new SidebarItem({
+			label: '了解我们',
+			items: await this.getSiblingSidebarItems(),
+			link: '',
+		});
+	}
+}

package/dist/entities/Tag.ts

@@ -0,0 +1,42 @@
+import blogDB from '../database/BlogDB';
+import { SidebarItem } from './SidebarItem';
+import { type TagStaticPath } from '../types/static-path';
+import { LinkUtil } from '../utils/link';
+
+export class Tag {
+	name: string;
+	lang: string;
+	count: number;
+
+	constructor(name: string, count: number, lang: string) {
+		this.name = name;
+		this.count = count;
+		this.lang = lang;
+	}
+
+	toSidebarItem(lang: string): SidebarItem {
+		return new SidebarItem({
+			label: this.name,
+			link: LinkUtil.getTagLink(lang, this.name),
+		});
+	}
+
+	toTagPath(): TagStaticPath {
+		return {
+			params: { slug: this.lang + '/blogs/tag/' + this.name },
+			props: { tag: this.name },
+		};
+	}
+
+	static async makeRootSidebarItem(lang: string): Promise<SidebarItem> {
+		const tags = await blogDB.getTagsByLang(lang);
+
+		return new SidebarItem({
+			label: 'Tags',
+			link: LinkUtil.getTagLink(lang, ''),
+			items: tags.map((tag: Tag) => tag.toSidebarItem(lang)),
+		});
+	}
+}
+
+export default Tag;

package/dist/index.ts

@@ -94,7 +94,7 @@ export * from './types/meta';
 export type { ImageProvider, ImageOptions } from './utils/image';
 
 // Models
-export * from './models/BaseDoc';
+export * from './entities/BaseDoc';
 
 // Database
 export * from './database/BaseDB';

package/dist/types/static-path.ts

@@ -0,0 +1,8 @@
+export interface TagStaticPath {
+	params: {
+		slug: string;
+	};
+	props: {
+		tag: string;
+	};
+}