@coffic/cosy-ui 0.7.2 → 0.8.6

package/dist/entities/BaseDoc.ts

@@ -1,195 +0,0 @@
-import { render, type RenderResult, type CollectionEntry, type DataEntryMap } from 'astro:content';
-import { SidebarItemEntity, type SidebarProvider } from './SidebarItem';
-import { cosyLogger, ERROR_PREFIX } from '../cosy';
-
-/**
- * 文档基类，提供所有文档类型共享的基本功能
- */
-export abstract class BaseDoc<
-	Collection extends keyof DataEntryMap,
-	T extends CollectionEntry<Collection>,
-> implements SidebarProvider {
-	protected entry: T;
-
-	constructor(entry: T) {
-		this.entry = entry;
-	}
-
-	/**
-	 * 获取顶级文档
-	 * 子类应该实现此方法以提供正确的顶级文档
-	 */
-	abstract getTopDoc(): Promise<BaseDoc<Collection, T> | null>;
-
-	/**
-	 * 获取子文档
-	 * 子类应该实现此方法以提供正确的子文档列表
-	 */
-	abstract getChildren(): Promise<BaseDoc<Collection, T>[]>;
-
-	/**
-	 * 获取文档的层级深度
-	 * 例如：对于 ID 为 "zh-cn/blog/typescript" 的文档，深度为3
-	 */
-	getLevel(): number {
-		return this.entry.id.split('/').length;
-	}
-
-	/**
-	 * 获取所有祖先文档的ID
-	 * 例如：对于 ID 为 "zh-cn/blog/typescript" 的文档，祖先ID为 ["zh-cn/blog", "zh-cn"]
-	 * @returns 祖先文档的ID列表
-	 */
-	getAncestorIds(): string[] {
-		const parts = this.entry.id.split('/');
-		return parts.slice(0, -1).map((_part, index) => parts.slice(0, index + 1).join('/'));
-	}
-
-	/**
-	 * 获取指定层级的祖先文档ID
-	 * 例如：对于 ID 为 "zh-cn/blog/typescript" 的文档，level=2 的祖先ID为 "zh-cn/blog"
-	 * @param level 层级深度，从1开始
-	 * @returns 祖先文档的ID
-	 */
-	getAncestorId(level: number): string {
-		const ancestorIds = this.getAncestorIds();
-
-		if (level < 1) {
-			cosyLogger.error('Level must be greater than 0');
-			throw new Error(ERROR_PREFIX + 'Level must be greater than 0');
-		}
-
-		if (level >= this.getLevel()) {
-			cosyLogger.debug("当前文档的ID：" + this.entry.id);
-			cosyLogger.debug("当前文档的Level：" + this.getLevel());
-			cosyLogger.debug("正在获取祖先ID，level：" + level);
-
-			throw new Error(ERROR_PREFIX + 'Level must be less than the document level');
-		}
-
-		if (ancestorIds.length < level) {
-			cosyLogger.debug("当前文档的ID\n" + this.entry.id);
-			cosyLogger.array("当前文档的祖先IDs", ancestorIds);
-			cosyLogger.debug("正在获取祖先ID，level:\n" + level);
-
-			throw new Error(ERROR_PREFIX + 'Level must be greater than 0');
-		}
-
-		return ancestorIds[level - 1];
-	}
-
-	/**
-	 * 获取顶级侧边栏项目
-	 * 如果有顶级文档，返回顶级文档的侧边栏项目
-	 * 否则返回当前文档的侧边栏项目
-	 */
-	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(),
-		});
-	}
-
-	/**
-	 * 获取父文档ID
-	 * 例如：对于 ID 为 "zh-cn/blog/typescript" 的文档，父ID为 "zh-cn/blog"
-	 *
-	 * @returns 父文档ID，如果没有父文档则返回null
-	 */
-	getParentId(): string | null {
-		return this.getAncestorId(this.getLevel() - 1);
-	}
-
-	/**
-	 * 获取顶级文档的ID
-	 * 例如：对于 ID 为 "zh-cn/blog/typescript" 的文档，顶级ID为 "zh-cn/blog"
-	 *
-	 * 默认实现假设顶级ID是前两部分
-	 * 子类可以根据需要覆盖此方法
-	 */
-	getTopDocId(): string {
-		const level = this.getLevel();
-
-		if (level <= 2) {
-			return this.entry.id;
-		}
-
-		return this.getAncestorId(2);
-	}
-
-	/**
-	 * 获取文档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);
-	}
-
-	/**
-	 * 转换为侧边栏项目
-	 * 如果文档有子文档，会包含子文档的侧边栏项目
-	 */
-	async toSidebarItem(): Promise<SidebarItemEntity> {
-		const debug = false;
-
-		const children = await this.getChildren();
-		const childItems = await Promise.all(children.map((child) => child.toSidebarItem()));
-
-		if (debug) {
-			cosyLogger.info(`${this.entry.id} 的侧边栏项目`);
-			console.log(childItems);
-		}
-
-		return new SidebarItemEntity({
-			text: this.getTitle(),
-			items: childItems,
-			link: this.getLink(),
-		});
-	}
-}

package/dist/entities/CourseDoc.ts

@@ -1,96 +0,0 @@
-import { cosyLogger } from '../cosy';
-import { SidebarItemEntity } from './SidebarItem';
-import type { CourseEntry } from '../database/CourseDB';
-import { courseDB } from '../database/CourseDB';
-import { LinkUtil } from '../utils/link';
-import { COLLECTION_COURSE } from '../database/CourseDB';
-import { BaseDoc } from './BaseDoc';
-
-export default class CourseDoc extends BaseDoc<typeof COLLECTION_COURSE, CourseEntry> {
-	constructor(entry: CourseEntry) {
-		super(entry);
-	}
-
-	static fromEntry(entry: CourseEntry) {
-		return new CourseDoc(entry);
-	}
-
-	getLink(): string {
-		return LinkUtil.getCourseLink(this.entry.id);
-	}
-
-	getOrder(): number {
-		return this.entry.data.order;
-	}
-
-	isFolder(): boolean {
-		return this.entry.data.folder;
-	}
-
-	async getTopDoc(): Promise<CourseDoc | null> {
-		const id = this.getTopDocId();
-		const doc = await courseDB.find(id);
-		return doc;
-	}
-
-	async getAncestor(level: number): Promise<CourseDoc | null> {
-		const debug = false;
-		if (debug) {
-			cosyLogger.info(`获取 ${this.entry.id} 的祖先文档，level: ${level}`);
-		}
-
-		if (level >= this.getLevel()) {
-			if (debug) {
-				cosyLogger.info(`祖先文档为自身`);
-			}
-			return this;
-		}
-
-		const id = this.getAncestorId(level);
-		const doc = await courseDB.find(id);
-		return doc;
-	}
-
-	/**
-	 * 获取子文档
-	 * @returns 子文档列表
-	 */
-	async getChildren(): Promise<CourseDoc[]> {
-		const debug = false;
-		const children = (await courseDB.getChildren(this.entry.id)).sort(
-			(a, b) => a.getOrder() - b.getOrder()
-		);
-		if (debug && children.length > 0) {
-			cosyLogger.array(
-				`${this.entry.id} 的子文档(${children.length})`,
-				children.map((child) => `#${child.getOrder()} ${child.entry.id}`)
-			);
-		}
-		return children;
-	}
-
-	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) {
-			cosyLogger.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

@@ -1,114 +0,0 @@
-import type { ExperimentEntry } from '../database/ExperimentDB';
-import { experimentDB } from '../database/ExperimentDB';
-import { cosyLogger } from '../cosy';
-import { SidebarItemEntity } from './SidebarItem';
-import { LinkUtil } from '../utils/link';
-import { COLLECTION_EXPERIMENT } from '../database/ExperimentDB';
-import { BaseDoc } from './BaseDoc';
-import type { IHeadingType } from '../types/heading';
-
-export default class ExperimentDoc extends BaseDoc<typeof COLLECTION_EXPERIMENT, ExperimentEntry> {
-	constructor(entry: ExperimentEntry) {
-		super(entry);
-	}
-
-	isBook(): boolean {
-		return this.entry.id.split('/').length === 2;
-	}
-
-	async getBookId(): Promise<string> {
-		return 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) {
-			cosyLogger.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) {
-			cosyLogger.info(`获取 ${this.entry.id} 的语言: ${lang}`);
-		}
-
-		return lang;
-	}
-
-	getHTML(): string {
-		const debug = false;
-
-		if (debug) {
-			cosyLogger.info(`获取 ${this.entry.id} 的 HTML`);
-		}
-
-		return this.entry.rendered?.html || '';
-	}
-
-	getHeadings(): IHeadingType[] {
-		const debug = false;
-
-		if (debug) {
-			cosyLogger.info(`获取 ${this.entry.id} 的 headings`);
-		}
-
-		return (this.entry.rendered?.metadata?.headings as IHeadingType[]) || [];
-	}
-
-	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) {
-			cosyLogger.info(`${this.entry.id} 的侧边栏项目`);
-			console.log(childItems);
-		}
-
-		return new SidebarItemEntity({
-			text: this.getTitle(),
-			items: childItems,
-			link: this.getLink(),
-		});
-	}
-}

package/dist/entities/Feature.ts

@@ -1,53 +0,0 @@
-class Feature {
-    private translations: Map<string, string>;
-    public emoji: string = '';
-    public link: string = '';
-    public presetIcon: string = '';
-
-    private constructor() {
-        this.translations = new Map();
-        this.translations.set('zh-cn', '');
-        this.translations.set('en', '');
-    }
-
-    public static createWithIcon(emoji: string): Feature {
-        const feature = new Feature();
-        feature.emoji = emoji;
-        return feature;
-    }
-
-    public static createWithPresetIcon(presetIcon: string): Feature {
-        const feature = new Feature();
-        feature.presetIcon = presetIcon;
-        return feature;
-    }
-
-    public setTitle(title: string, lang: string): Feature {
-        this.translations.set(lang, title);
-        return this;
-    }
-
-    public setLink(link: string): Feature {
-        this.link = link;
-        return this;
-    }
-
-    public setPresetIcon(presetIcon: string): Feature {
-        this.presetIcon = presetIcon;
-        return this;
-    }
-
-    public setZh(title: string): Feature {
-        return this.setTitle(title, 'zh-cn');
-    }
-
-    public setEn(title: string): Feature {
-        return this.setTitle(title, 'en');
-    }
-
-    public getTitle(lang: string): string {
-        return this.translations.get(lang) || '';
-    }
-}
-
-export default Feature;

package/dist/entities/LessonDoc.ts

@@ -1,148 +0,0 @@
-import type { LessonEntry } from '../database/LessonDB';
-import { lessonDB } from '../database/LessonDB';
-import { cosyLogger } from '../cosy';
-import { SidebarItemEntity } from './SidebarItem';
-import { LinkUtil } from '../utils/link';
-import { COLLECTION_LESSON } from '../database/LessonDB';
-import { BaseDoc } from './BaseDoc';
-import type { IHeadingType } from '../types/heading';
-
-/**
- * 课程文档类，配合 LessonDB 使用
- * 
- * 目录结构：
- * ```
- * lessons/
- * ├── build_your_own_web_toolbox/      # 课程目录
- * │   ├── images/                      # 课程图片资源
- * │   ├── components/                  # 课程组件
- * │   ├── en/                          # 英文版本
- * │   │   ├── index.mdx                # 课程首页
- * │   │   ├── 1.mdx                    # 第一章
- * │   │   └── 2.mdx                    # 第二章
- * │   └── zh-cn/                       # 中文版本
- * │       ├── index.mdx                # 课程首页
- * │       ├── 1.mdx                    # 第一章
- * │       └── 2.mdx                    # 第二章
- * └── learn_astro/                     # 另一个课程
- *     ├── en/
- *     │   ├── index.mdx
- *     │   ├── 1.mdx
- *     │   └── 2.mdx
- *     └── zh-cn/
- *         ├── index.mdx
- *         ├── 1.mdx
- *         └── 2.mdx
- * ```
- *
- * 说明：
- * - 每个课程（如 build_your_own_web_toolbox）是一个独立的目录
- * - 课程目录可以包含多语言版本（en, zh-cn 等）
- * - 每个语言版本包含完整的课程内容
- * - 课程目录可以作为 git 子模块独立管理
- */
-export default class LessonDoc extends BaseDoc<typeof COLLECTION_LESSON, LessonEntry> {
-	constructor(entry: LessonEntry) {
-		super(entry);
-	}
-
-	isBook(): boolean {
-		return this.entry.id.split('/').length === 2;
-	}
-
-	async getBookId(): Promise<string> {
-		return 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) {
-			cosyLogger.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) {
-			cosyLogger.info(`获取 ${this.entry.id} 的语言: ${lang}`);
-		}
-
-		return lang;
-	}
-
-	getHTML(): string {
-		const debug = false;
-
-		if (debug) {
-			cosyLogger.info(`获取 ${this.entry.id} 的 HTML`);
-		}
-
-		return this.entry.rendered?.html || '';
-	}
-
-	getHeadings(): IHeadingType[] {
-		const debug = false;
-
-		if (debug) {
-			cosyLogger.info(`获取 ${this.entry.id} 的 headings`);
-		}
-
-		return (this.entry.rendered?.metadata?.headings as IHeadingType[]) || [];
-	}
-
-	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) {
-			cosyLogger.info(`${this.entry.id} 的侧边栏项目`);
-			console.log(childItems);
-		}
-
-		return new SidebarItemEntity({
-			text: this.getTitle(),
-			items: childItems,
-			link: this.getLink(),
-		});
-	}
-}

package/dist/entities/MetaDoc.ts

@@ -1,90 +0,0 @@
-import { SidebarItemEntity } from './SidebarItem';
-import type { MetaEntry } from '../database/MetaDB';
-import { LinkUtil } from '../utils/link';
-import { BaseDoc } from './BaseDoc';
-import { metaDB } from '../database/MetaDB';
-import { COLLECTION_META } from '../database/MetaDB';
-
-export default class MetaDoc extends BaseDoc<typeof COLLECTION_META, MetaEntry> {
-	constructor(entry: MetaEntry) {
-		super(entry);
-	}
-
-	static fromEntry(entry: MetaEntry) {
-		return new MetaDoc(entry);
-	}
-
-	getTopDoc(): Promise<MetaDoc | null> {
-		return Promise.resolve(null);
-	}
-
-	getChildren(): Promise<MetaDoc[]> {
-		return Promise.resolve([]);
-	}
-
-	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<SidebarItemEntity[]> {
-		const siblings = await this.getSiblingDocs();
-		const siblingItems = await Promise.all(
-			siblings.map((sibling) => {
-				return new SidebarItemEntity({
-					text: sibling.getTitle(),
-					link: sibling.getLink(),
-				});
-			})
-		);
-		return siblingItems;
-	}
-
-	/**
-	 * 重写侧边栏项目方法
-	 * 对于元数据页面，我们不显示子项目
-	 */
-	override async toSidebarItem(): Promise<SidebarItemEntity> {
-		return new SidebarItemEntity({
-			text: this.getTitle(),
-			link: this.getLink(),
-		});
-	}
-
-	/**
-	 * 重写顶级侧边栏项目方法
-	 * 对于元数据页面，我们显示所有兄弟页面作为侧边栏项目
-	 */
-	async getTopSidebarItem(): Promise<SidebarItemEntity> {
-		return new SidebarItemEntity({
-			text: '了解我们',
-			items: await this.getSiblingSidebarItems(),
-			link: '',
-		});
-	}
-}