@coffic/cosy-ui 0.5.8 → 0.5.14

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 { 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_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<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: '',
+		});
+	}
+}

package/dist/entities/Tag.ts

@@ -0,0 +1,42 @@
+import blogDB from '../database/BlogDB';
+import { SidebarItemEntity } 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): SidebarItemEntity {
+		return new SidebarItemEntity({
+			text: 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<SidebarItemEntity> {
+		const tags = await blogDB.getTagsByLang(lang);
+
+		return new SidebarItemEntity({
+			text: 'Tags',
+			link: LinkUtil.getTagLink(lang, ''),
+			items: tags.map((tag: Tag) => tag.toSidebarItem(lang)),
+		});
+	}
+}
+
+export default Tag;

package/dist/index.ts

@@ -7,6 +7,14 @@ export { default as Alert } from './components/base/Alert.astro';
 export { default as Speak } from './components/base/Speak.astro';
 export { default as Module } from './components/base/Module.astro';
 
+// Collections
+export * from './collections/ArticleCollection';
+export * from './collections/BlogCollection';
+export * from './collections/CourseCollection';
+export * from './collections/ExperimentCollection';
+export * from './collections/LessonCollection';
+export * from './collections/MetaCollection';
+
 // Navigation
 export { default as ThemeSwitcher } from './components/navigation/ThemeSwitcher.astro';
 export { default as TableOfContents } from './components/navigation/TableOfContents.astro';
@@ -94,7 +102,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;
+	};
+}

package/dist/utils/image.ts

@@ -6,78 +6,82 @@
 export type ImageProvider = 'picsum' | 'unsplash' | 'placeholder' | 'robohash';
 
 export interface ImageOptions {
-    width: number;
-    height: number;
-    tag?: string;
-    randomSeed?: number | string;
-    provider?: ImageProvider;
-    grayscale?: boolean;
-    blur?: number;
+	width: number;
+	height: number;
+	tag?: string;
+	randomSeed?: number | string;
+	provider?: ImageProvider;
+	grayscale?: boolean;
+	blur?: number;
 }
 
 /**
  * 获取示例图片URL
  * @param options 图片选项配置
  * @returns 生成的图片URL
- * 
+ *
  * @example
  * // 基本用法
  * getExampleImage({ width: 400, height: 300 })
- * 
+ *
  * @example
  * // 使用Unsplash并添加标签
- * getExampleImage({ 
- *   width: 400, 
- *   height: 300, 
- *   provider: 'unsplash', 
- *   tag: 'nature' 
+ * getExampleImage({
+ *   width: 400,
+ *   height: 300,
+ *   provider: 'unsplash',
+ *   tag: 'nature'
  * })
  */
 export function getExampleImage(options: ImageOptions): string {
-    const {
-        width,
-        height,
-        provider = 'picsum',
-        tag = '',
-        randomSeed = Math.floor(Math.random() * 1000),
-        grayscale = false,
-        blur = 0
-    } = options;
+	const {
+		width,
+		height,
+		provider = 'picsum',
+		tag = '',
+		randomSeed = Math.floor(Math.random() * 1000),
+		grayscale = false,
+		blur = 0,
+	} = options;
 
-    switch (provider) {
-        case 'picsum':
-            const picsumParams = [];
-            if (grayscale) picsumParams.push('grayscale');
-            if (blur > 0 && blur <= 10) picsumParams.push(`blur=${blur}`);
+	switch (provider) {
+		case 'picsum': {
+			const picsumParams = [];
+			if (grayscale) picsumParams.push('grayscale');
+			if (blur > 0 && blur <= 10) picsumParams.push(`blur=${blur}`);
 
-            const picsumQuery = picsumParams.length ?
-                `?${picsumParams.join('&')}` :
-                `?random=${randomSeed}`;
+			const picsumQuery = picsumParams.length
+				? `?${picsumParams.join('&')}`
+				: `?random=${randomSeed}`;
 
-            return `https://picsum.photos/${width}/${height}${picsumQuery}`;
+			return `https://picsum.photos/${width}/${height}${picsumQuery}`;
+		}
 
-        case 'unsplash':
-            const tagQuery = tag ? `?${tag}` : '';
-            return `https://source.unsplash.com/random/${width}x${height}${tagQuery}`;
+		case 'unsplash': {
+			const tagQuery = tag ? `?${tag}` : '';
+			return `https://source.unsplash.com/random/${width}x${height}${tagQuery}`;
+		}
 
-        case 'placeholder':
-            const color = grayscale ? 'gray' : '';
-            const placeholderParams = [];
-            if (tag) placeholderParams.push(`text=${encodeURIComponent(tag)}`);
-            if (color) placeholderParams.push(`bg=${color}`);
+		case 'placeholder': {
+			const color = grayscale ? 'gray' : '';
+			const placeholderParams = [];
+			if (tag) placeholderParams.push(`text=${encodeURIComponent(tag)}`);
+			if (color) placeholderParams.push(`bg=${color}`);
 
-            const placeholderQuery = placeholderParams.length ?
-                `?${placeholderParams.join('&')}` : '';
+			const placeholderQuery = placeholderParams.length ? `?${placeholderParams.join('&')}` : '';
 
-            return `https://via.placeholder.com/${width}x${height}${placeholderQuery}`;
+			return `https://via.placeholder.com/${width}x${height}${placeholderQuery}`;
+		}
 
-        case 'robohash':
-            const seed = String(tag || randomSeed);
-            return `https://robohash.org/${encodeURIComponent(seed)}?size=${width}x${height}`;
+		case 'robohash': {
+			const seed = String(tag || randomSeed);
+			return `https://robohash.org/${encodeURIComponent(seed)}?size=${width}x${height}`;
+		}
 
-        default:
-            return `https://picsum.photos/${width}/${height}?random=${randomSeed}`;
-    }
+		default: {
+			return `https://picsum.photos/${width}/${height}?random=${randomSeed}`;
+		}
+	}
 }
 
 /**
@@ -85,13 +89,13 @@ export function getExampleImage(options: ImageOptions): string {
  * @param options 可选的图片选项配置
  */
 export function getProductImage(options: Partial<ImageOptions> = {}): string {
-    return getExampleImage({
-        width: options.width || 400,
-        height: options.height || 300,
-        provider: options.provider || 'picsum',
-        tag: options.tag || 'product',
-        ...options
-    });
+	return getExampleImage({
+		width: options.width || 400,
+		height: options.height || 300,
+		provider: options.provider || 'picsum',
+		tag: options.tag || 'product',
+		...options,
+	});
 }
 
 /**
@@ -99,12 +103,12 @@ export function getProductImage(options: Partial<ImageOptions> = {}): string {
  * @param options 可选的图片选项配置
  */
 export function getAvatarImage(options: Partial<ImageOptions> = {}): string {
-    return getExampleImage({
-        width: options.width || 200,
-        height: options.height || 200,
-        provider: options.provider || 'robohash',
-        ...options
-    });
+	return getExampleImage({
+		width: options.width || 200,
+		height: options.height || 200,
+		provider: options.provider || 'robohash',
+		...options,
+	});
 }
 
 /**
@@ -112,11 +116,11 @@ export function getAvatarImage(options: Partial<ImageOptions> = {}): string {
  * @param options 可选的图片选项配置
  */
 export function getLandscapeImage(options: Partial<ImageOptions> = {}): string {
-    return getExampleImage({
-        width: options.width || 800,
-        height: options.height || 400,
-        provider: options.provider || 'unsplash',
-        tag: options.tag || 'landscape',
-        ...options
-    });
-} 
+	return getExampleImage({
+		width: options.width || 800,
+		height: options.height || 400,
+		provider: options.provider || 'unsplash',
+		tag: options.tag || 'landscape',
+		...options,
+	});
+}