@coffic/cosy-ui 0.5.12 → 0.6.2

package/dist/entities/MetaDoc.ts

@@ -1,4 +1,4 @@
-import { SidebarItem } from './SidebarItem';
+import { SidebarItemEntity } from './SidebarItem';
 import type { MetaEntry } from '../database/MetaDB';
 import { LinkUtil } from '../utils/link';
 import { BaseDoc } from './BaseDoc';
@@ -44,12 +44,12 @@ export default class MetaDoc extends BaseDoc<typeof COLLECTION_NAME, MetaEntry>
 	/**
 	 * 获取兄弟文档的侧边栏项目
 	 */
-	async getSiblingSidebarItems(): Promise<SidebarItem[]> {
+	async getSiblingSidebarItems(): Promise<SidebarItemEntity[]> {
 		const siblings = await this.getSiblingDocs();
 		const siblingItems = await Promise.all(
 			siblings.map((sibling) => {
-				return new SidebarItem({
-					label: sibling.getTitle(),
+				return new SidebarItemEntity({
+					text: sibling.getTitle(),
 					link: sibling.getLink(),
 				});
 			})
@@ -61,9 +61,9 @@ export default class MetaDoc extends BaseDoc<typeof COLLECTION_NAME, MetaEntry>
 	 * 重写侧边栏项目方法
 	 * 对于元数据页面，我们不显示子项目
 	 */
-	override async toSidebarItem(): Promise<SidebarItem> {
-		return new SidebarItem({
-			label: this.getTitle(),
+	override async toSidebarItem(): Promise<SidebarItemEntity> {
+		return new SidebarItemEntity({
+			text: this.getTitle(),
 			link: this.getLink(),
 		});
 	}
@@ -72,9 +72,9 @@ export default class MetaDoc extends BaseDoc<typeof COLLECTION_NAME, MetaEntry>
 	 * 重写顶级侧边栏项目方法
 	 * 对于元数据页面，我们显示所有兄弟页面作为侧边栏项目
 	 */
-	async getTopSidebarItem(): Promise<SidebarItem> {
-		return new SidebarItem({
-			label: '了解我们',
+	async getTopSidebarItem(): Promise<SidebarItemEntity> {
+		return new SidebarItemEntity({
+			text: '了解我们',
 			items: await this.getSiblingSidebarItems(),
 			link: '',
 		});

package/dist/entities/SidebarItem.ts

@@ -1,79 +1,75 @@
-import { type SidebarItem } from '../types/sidebar';
+import { type ISidebarItem } from '../types/sidebar';
 
 /**
  * 侧边栏项目类
  * 用于构建网站的侧边栏导航
  */
-export class SidebarItemEntity implements SidebarItem {
-    text: string;
-    href: string;
-    items: SidebarItem[];
+export class SidebarItemEntity implements ISidebarItem {
+	text: string;
+	href: string;
+	items: ISidebarItem[];
 
-    constructor(props: {
-        text: string;
-        link?: string;
-        items?: SidebarItem[];
-    }) {
-        this.text = props.text;
-        this.href = props.link || '';
-        this.items = props.items || [];
-    }
+	constructor(props: { text: string; link?: string; items?: ISidebarItem[] }) {
+		this.text = props.text;
+		this.href = props.link || '';
+		this.items = props.items || [];
+	}
 
-    /**
-     * 添加子项目
-     * @param item 要添加的子项目
-     */
-    addItem(item: SidebarItemEntity): void {
-        this.items.push(item);
-    }
+	/**
+	 * 添加子项目
+	 * @param item 要添加的子项目
+	 */
+	addItem(item: SidebarItemEntity): void {
+		this.items.push(item);
+	}
 
-    /**
-     * 获取所有子项目
-     * @returns 子项目数组
-     */
-    getItems(): SidebarItemEntity[] {
-        return this.items.map(item => new SidebarItemEntity(item));
-    }
+	/**
+	 * 获取所有子项目
+	 * @returns 子项目数组
+	 */
+	getItems(): SidebarItemEntity[] {
+		return this.items.map((item) => new SidebarItemEntity(item));
+	}
 
-    /**
-     * 获取项目标签
-     * @returns 项目标签
-     */
-    getLabel(): string {
-        return this.text;
-    }
+	/**
+	 * 获取项目标签
+	 * @returns 项目标签
+	 */
+	getLabel(): string {
+		return this.text;
+	}
 
-    /**
-     * 获取项目链接
-     * @returns 项目链接
-     */
-    getLink(): string {
-        return this.href;
-    }
+	/**
+	 * 获取项目链接
+	 * @returns 项目链接
+	 */
+	getLink(): string {
+		return this.href;
+	}
 
-    /**
-     * 获取包括自身在内的所有项目
-     * @returns 包括自身在内的所有项目
-     */
-    getItemsIncludingSelf(): SidebarItemEntity[] {
-        return [this, ...this.getItems()];
-    }
+	/**
+	 * 获取包括自身在内的所有项目
+	 * @returns 包括自身在内的所有项目
+	 */
+	getItemsIncludingSelf(): SidebarItemEntity[] {
+		return [this, ...this.getItems()];
+	}
 
-    /**
-     * 判断是否是分组（有子项目）
-     * @returns 是否是分组
-     */
-    isGroup(): boolean {
-        return this.items.length > 0;
-    }
+	/**
+	 * 判断是否是分组（有子项目）
+	 * @returns 是否是分组
+	 */
+	isGroup(): boolean {
+		return this.items.length > 0;
+	}
 
-    /**
-     * 判断是否不是分组
-     * @returns 是否不是分组
-     */
-    isNotGroup(): boolean {
-        return !this.isGroup();
-    }
+	/**
+	 * 判断是否不是分组
+	 * @returns 是否不是分组
+	 */
+	isNotGroup(): boolean {
+		return !this.isGroup();
+	}
 }
 
 /**
@@ -81,13 +77,13 @@ export class SidebarItemEntity implements SidebarItem {
  * 实现此接口的类可以提供侧边栏项目
  */
 export interface SidebarProvider {
-    /**
-     * 转换为侧边栏项目
-     */
-    toSidebarItem(): Promise<SidebarItemEntity>;
+	/**
+	 * 转换为侧边栏项目
+	 */
+	toSidebarItem(): Promise<SidebarItemEntity>;
 
-    /**
-     * 获取顶级侧边栏项目
-     */
-    getTopSidebarItem?(): Promise<SidebarItemEntity>;
-} 
+	/**
+	 * 获取顶级侧边栏项目
+	 */
+	getTopSidebarItem?(): Promise<SidebarItemEntity>;
+}

package/dist/entities/Tag.ts

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

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';
@@ -91,10 +99,22 @@ export * from './types/layout';
 export * from './types/header';
 export * from './types/heading';
 export * from './types/meta';
+export * from './types/nav';
+export * from './types/product';
+export * from './types/footer';
+export * from './types/static-path';
 export type { ImageProvider, ImageOptions } from './utils/image';
 
-// Models
+// Entities
 export * from './entities/BaseDoc';
+export * from './entities/BlogDoc';
+export * from './entities/CourseDoc';
+export * from './entities/ExperimentDoc';
+export * from './entities/Heading';
+export * from './entities/LessonDoc';
+export * from './entities/MetaDoc';
+export * from './entities/SidebarItem';
+export * from './entities/Tag';
 
 // Database
 export * from './database/BaseDB';

package/dist/types/article.ts

@@ -1,22 +1,22 @@
-export interface ArticleProps {
-    /**
-     * 文章的类名
-     */
-    class?: string;
+export interface IArticleProps {
+	/**
+	 * 文章的类名
+	 */
+	class?: string;
 
-    /**
-     * 类名列表
-     */
-    'class:list'?: any;
+	/**
+	 * 类名列表
+	 */
+	'class:list'?: any;
 
-    /**
-     * 内联样式
-     */
-    style?: string;
+	/**
+	 * 内联样式
+	 */
+	style?: string;
 
-    /**
-     * 文章宽度
-     * @default "medium"
-     */
-    width?: 'narrow' | 'medium' | 'wide' | 'full';
-}
+	/**
+	 * 文章宽度
+	 * @default "medium"
+	 */
+	width?: 'narrow' | 'medium' | 'wide' | 'full';
+}

package/dist/types/footer.ts

@@ -1,15 +1,6 @@
-export interface Logo {
-	src: string;
-	alt: string;
-}
-
-export interface Product {
-	name: string;
-	href: string;
-	external?: boolean;
-}
+import type { ILogo, IProduct } from './product';
 
-export interface FooterProps {
+export interface IFooterProps {
 	/**
 	 * 关于链接
 	 */
@@ -79,7 +70,7 @@ export interface FooterProps {
 	/**
 	 * 徽标
 	 */
-	logo?: Logo;
+	logo?: ILogo;
 
 	/**
 	 * 媒体链接
@@ -104,7 +95,7 @@ export interface FooterProps {
 	/**
 	 * 产品
 	 */
-	products?: Product[];
+	products?: IProduct[];
 
 	/**
 	 * 站点名称

package/dist/types/header.ts

@@ -1,4 +1,6 @@
-export interface HeaderProps {
+import type { INavItem } from './nav';
+
+export interface IHeaderProps {
 	/**
 	 * 侧边栏是否默认展开
 	 * @default false
@@ -30,7 +32,7 @@ export interface HeaderProps {
 	/**
 	 * 导航菜单项
 	 */
-	navItems?: NavItem[];
+	navItems?: INavItem[];
 
 	/**
 	 * 是否显示侧边栏切换按钮
@@ -60,5 +62,3 @@ export interface HeaderProps {
 
 	navPosition?: 'start' | 'center' | 'end';
 }
-
-export type NavItem = { href: string; label: string };

package/dist/types/heading.ts

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

package/dist/types/layout.ts

@@ -1,71 +1,71 @@
-import type { FooterProps } from "./footer";
-import type { HeaderProps } from "./header";
-import type { MainContentProps } from "./main";
-import type { MetaProps } from "./meta";
-import type { SidebarProps } from "./sidebar";
+import type { IFooterProps } from './footer';
+import type { IHeaderProps } from './header';
+import type { IMainContentProps } from './main';
+import type { IMetaProps } from './meta';
+import type { ISidebarProps } from './sidebar';
 
-export interface AppLayoutProps {
-    /**
-     * 是否显示侧边栏
-     * @default true
-     */
-    showSidebar?: boolean;
+export interface IAppLayoutProps {
+	/**
+	 * 是否显示侧边栏
+	 * @default true
+	 */
+	showSidebar?: boolean;
 
-    /**
-     * 是否显示页眉
-     * @default true
-     */
-    showHeader?: boolean;
+	/**
+	 * 是否显示页眉
+	 * @default true
+	 */
+	showHeader?: boolean;
 
-    /**
-     * 是否显示页脚
-     * @default true
-     */
-    showFooter?: boolean;
+	/**
+	 * 是否显示页脚
+	 * @default true
+	 */
+	showFooter?: boolean;
 
-    /**
-     * 自定义头部内容
-     */
-    head?: astroHTML.JSX.Element;
+	/**
+	 * 自定义头部内容
+	 */
+	head?: astroHTML.JSX.Element;
 
-    /**
-     * 自定义头部内容
-     */
-    headerConfig: HeaderProps;
+	/**
+	 * 自定义头部内容
+	 */
+	headerConfig: IHeaderProps;
 
-    /**
-     * 侧边栏配置
-     */
-    sidebarConfig: SidebarProps;
+	/**
+	 * 侧边栏配置
+	 */
+	sidebarConfig: ISidebarProps;
 
-    /**
-     * 主内容配置
-     */
-    mainContentConfig: MainContentProps;
+	/**
+	 * 主内容配置
+	 */
+	mainContentConfig: IMainContentProps;
 
-    /**
-     * 页面类名
-     */
-    class?: string;
+	/**
+	 * 页面类名
+	 */
+	class?: string;
 
-    /**
-     * 类名列表
-     */
-    'class:list'?: any;
+	/**
+	 * 类名列表
+	 */
+	'class:list'?: any;
 
-    /**
-     * 调试模式，显示各个部分的边框
-     * @default false
-     */
-    debug?: boolean;
+	/**
+	 * 调试模式，显示各个部分的边框
+	 * @default false
+	 */
+	debug?: boolean;
 
-    /**
-     * 元数据配置
-     */
-    metaConfig: MetaProps;
+	/**
+	 * 元数据配置
+	 */
+	metaConfig: IMetaProps;
 
-    /**
-     * 页脚相关配置
-     */
-    footerConfig: FooterProps;
-}
+	/**
+	 * 页脚相关配置
+	 */
+	footerConfig: IFooterProps;
+}