@coffic/cosy-ui 0.9.4 → 0.9.6

package/dist/index-astro.ts

@@ -63,22 +63,8 @@ export * from './src-astro/types/sidebar';
 export * from './src-astro/types/static-path';
 
 // 实体类 (按字母顺序)
-export * from './src-astro/entities/BaseDoc';
-export * from './src-astro/entities/BlogDoc';
-export * from './src-astro/entities/CourseDoc';
-export * from './src-astro/entities/ExperimentDoc';
-export * from './src-astro/entities/LessonDoc';
-export * from './src-astro/entities/MetaDoc';
-export * from './src-astro/entities/SidebarItem';
-export * from './src-astro/entities/Tag';
-
-// 数据库类 (按字母顺序)
-export * from './src-astro/database/BaseDB';
-export * from './src-astro/database/BlogDB';
-export * from './src-astro/database/CourseDB';
-export * from './src-astro/database/ExperimentDB';
-export * from './src-astro/database/LessonDB';
-export * from './src-astro/database/MetaDB';
+export * from './src-astro/collection/entities/SidebarItem';
+export * from './src-astro/collection/entities/Tag';
 
 // 工具类型
 export type { ImageProvider, ImageOptions } from './src/utils/image';
@@ -93,6 +79,3 @@ export * from './src/utils/link';
 
 // 图标组件
 export * from './src-astro/icons';
-
-// 数据库
-export * from './src-astro/database/index'; 

package/dist/index-collection.ts

@@ -1,105 +1 @@
-import { defineCollection, z } from 'astro:content';
-import { glob } from 'astro/loaders';
-
-export const makeArticleCollection = (base: string) => {
-    return defineCollection({
-        loader: glob({
-            pattern: '**/*.{md,mdx}',
-            base,
-        }),
-        schema: z.object({
-            title: z.string().optional(),
-            folder: z.boolean().optional(),
-            order: z.number().optional(),
-            description: z.string().optional(),
-        }),
-    });
-};
-
-export const makeBlogCollection = (base: string) => {
-    return defineCollection({
-        loader: glob({
-            pattern: '**/*.{md,mdx}',
-            base,
-        }),
-        schema: z.object({
-            title: z.string(),
-            description: z.string().optional(),
-            tags: z.array(z.string()).optional(),
-            date: z.date().optional(),
-            authors: z
-                .array(
-                    z.object({
-                        name: z.string(),
-                        picture: z.string().optional(),
-                        url: z.string().optional(),
-                    })
-                )
-                .optional(),
-        }),
-    });
-};
-
-export const makeCourseCollection = (base: string) => {
-    return defineCollection({
-        loader: glob({
-            pattern: '**/*.{md,mdx}',
-            base,
-        }),
-        schema: z.object({
-            title: z.string().optional(),
-            description: z.string().optional(),
-            folder: z.boolean().optional(),
-            order: z.number().optional(),
-            badge: z.string().optional(),
-        }),
-    });
-};
-
-export const makeExperimentCollection = (base: string) => {
-    return defineCollection({
-        loader: glob({
-            pattern: '**/*.{md,mdx}',
-            base,
-        }),
-        schema: z.object({
-            title: z.string().optional(),
-            description: z.string().optional(),
-            pubDate: z.date().optional(),
-        }),
-    });
-};
-
-export const makeLessonCollection = (base: string) => {
-    return defineCollection({
-        loader: glob({
-            pattern: '**/*.{md,mdx}',
-            base,
-        }),
-        schema: z.object({
-            title: z.string().optional(),
-            description: z.string().optional(),
-            authors: z
-                .array(
-                    z.object({
-                        name: z.string(),
-                        picture: z.string().optional(),
-                    })
-                )
-                .optional(),
-        }),
-    });
-};
-
-export const makeMetaCollection = (base: string) => {
-    return defineCollection({
-        loader: glob({
-            pattern: '**/*.{md,mdx}',
-            base,
-        }),
-        schema: z.object({
-            title: z.string().optional(),
-            description: z.string().optional(),
-        }),
-    });
-};
+export * from './src-astro/collection';

package/dist/src-astro/collection/entities/BaseDoc.ts

@@ -0,0 +1,28 @@
+import type { CollectionEntry } from 'astro:content';
+
+/**
+ * 文档基类，提供所有文档类型共享的基本功能
+ */
+export abstract class BaseDoc {
+    abstract entry: CollectionEntry<string>;
+
+    getId(): string {
+        return this.entry.id as string;
+    }
+
+    getLevel(): number {
+        return this.getId().split('/').length;
+    }
+
+    getLang(): string {
+        return this.entry.id.split('/')[0];
+    }
+
+    getTitle(): string {
+        return this.entry.data.title as string;
+    }
+
+    getDescription(): string {
+        return this.entry.data.description as string;
+    }
+}

package/dist/src-astro/collection/entities/BlogDoc.ts

@@ -0,0 +1,221 @@
+import { LinkUtil } from '../../../src/utils/link';
+import Tag from './Tag';
+import { blogRepo, type BlogEntry } from '..';
+import { SidebarItemEntity, type SidebarProvider } from './SidebarItem';
+import { cosyLogger, ERROR_PREFIX } from '../../cosy';
+import { render } from 'astro:content';
+import { BaseDoc } from './BaseDoc';
+
+/**
+ * 博客文档类，配合 BlogRepo 使用
+ *
+ * 目录结构：
+ * ```
+ * blogs/
+ * ├── zh-cn/                        # 中文博客目录
+ * │   ├── typescript-intro.md      # 文章内容
+ * │   ├── images/                  # 文章相关图片
+ * │   └── web-performance.md
+ * └── en/                          # 英文博客目录
+ *     ├── typescript-intro.md
+ *     ├── images/
+ *     └── web-performance.md
+ * ```
+ *
+ * 说明：
+ * - 每个语言（如 zh-cn, en）是一个独立的目录，存放该语言下的所有博客文章
+ * - 每篇博客为一个 markdown 文件，文件名即为 slug
+ * - 每个语言目录下可包含 images 文件夹，存放该语言博客相关图片
+ * - 支持多语言博客内容，便于国际化
+ * - 博客目录可作为 git 子模块独立管理
+ *
+ * 相关：
+ * - BlogRepo：博客仓库管理类，负责博客文档的增删查改
+ * - BlogDoc：博客文档实体类，封装单篇博客的相关操作
+ *
+ * 用法示例：
+ * ```typescript
+ * import BlogDoc from '../entities/BlogDoc';
+ * import { blogRepo } from '../BlogRepo';
+ *
+ * // 获取所有中文博客
+ * const blogs = await blogRepo.allBlogsByLang('zh-cn');
+ *
+ * // 获取博客链接
+ * const link = blogs[0].getLink();
+ * ```
+ */
+
+export default class BlogDoc extends BaseDoc implements SidebarProvider {
+    entry: BlogEntry;
+
+    private constructor(entry: BlogEntry) {
+        super();
+        this.entry = entry;
+    }
+
+    static fromEntry(entry: BlogEntry) {
+        return new BlogDoc(entry);
+    }
+
+    getAncestorIds(): string[] {
+        const parts = this.entry.id.split('/');
+        return parts
+            .slice(0, -1)
+            .map((_part: string, index: number) => parts.slice(0, index + 1).join('/'));
+    }
+
+    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];
+    }
+
+    getParentId(): string | null {
+        return this.getAncestorId(this.getLevel() - 1);
+    }
+
+    getTopDocId(): string {
+        const level = this.getLevel();
+        if (level <= 2) {
+            return this.entry.id;
+        }
+        return this.getAncestorId(2);
+    }
+
+    getSlug(): string {
+        return this.getId().split('/').slice(1).join('/');
+    }
+
+    getDescription(): string {
+        return this.entry.data.description as string;
+    }
+
+    async getTopDoc(): Promise<BlogDoc | null> {
+        const id = this.getTopDocId();
+        const doc = await blogRepo.find(id);
+        return doc;
+    }
+
+    async getChildren(): Promise<BlogDoc[]> {
+        return await blogRepo.getChildren(this.entry.id);
+    }
+
+    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);
+            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';
+        }
+    }
+
+    getBadge(): string {
+        return this.entry.data.badge ?? '';
+    }
+
+    hasTag(tag: string): boolean {
+        return this.getTags().some((t) => t.name === tag);
+    }
+
+    hasBadge(): boolean {
+        return this.getBadge() !== '';
+    }
+
+    isDraft(): boolean {
+        return this.entry.data.draft ?? false;
+    }
+
+    isHidden(): boolean {
+        return this.entry.data.hidden ?? false;
+    }
+
+    isNotHidden(): boolean {
+        return !this.isHidden();
+    }
+
+    isFamous(): boolean {
+        return this.entry.data.famous ?? false;
+    }
+
+    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(),
+        });
+    }
+
+    async render(): Promise<any> {
+        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/src-astro/collection/entities/CourseDoc.ts

@@ -0,0 +1,254 @@
+import { cosyLogger } from '../../cosy';
+import { SidebarItemEntity, type SidebarProvider } from './SidebarItem';
+import { LinkUtil } from '../../../src/utils/link';
+import { render, type CollectionEntry } from 'astro:content';
+import { BaseDoc } from './BaseDoc';
+import { courseRepo } from '../repos/CourseRepo';
+
+export const COLLECTION_COURSE = 'courses' as const;
+export type CourseEntry = CollectionEntry<typeof COLLECTION_COURSE>;
+
+/**
+ * 课程文档类，配合 CourseRepo 使用
+ *
+ * 目录结构：
+ * ```
+ * courses/
+ * ├── zh-cn/                  # 中文版本
+ * │   ├── web-development/    # 课程1
+ * │   │   ├── index.md        # 课程文档
+ * │   │   ├── chapter1
+ * │   │   │   ├── index.md
+ * │   │   │   ├── content.md
+ * │   │   │   └── ...
+ * │   │   └── chapter2
+ * │   │       ├── index.md
+ * │   │       ├── content.md
+ * │   │       └── ...
+ * │   └── mobile-dev/        # 课程2
+ * │       ├── index.md
+ * │       └── ...
+ * └── en/                    # 英文版本
+ *     └── ...
+ * ```
+ */
+export default class CourseDoc extends BaseDoc implements SidebarProvider {
+    entry: CourseEntry;
+
+    constructor(entry: CourseEntry) {
+        super();
+        this.entry = entry;
+    }
+
+    static fromEntry(entry: CourseEntry) {
+        return new CourseDoc(entry);
+    }
+
+    getAncestorIds(): string[] {
+        const parts = this.entry.id.split('/');
+        return parts
+            .slice(0, -1)
+            .map((_part: string, index: number) => parts.slice(0, index + 1).join('/'));
+    }
+
+    getAncestorId(level: number): string {
+        const ancestorIds = this.getAncestorIds();
+
+        if (level < 1) {
+            cosyLogger.error('Level must be greater than 0');
+            throw new Error('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('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('Level must be greater than 0');
+        }
+
+        return ancestorIds[level - 1];
+    }
+
+    getParentId(): string | null {
+        return this.getAncestorId(this.getLevel() - 1);
+    }
+
+    getTopDocId(): string {
+        const level = this.getLevel();
+        if (level <= 2) {
+            return this.entry.id;
+        }
+        return this.getAncestorId(2);
+    }
+
+    getSlug(): string {
+        return this.getId().split('/').slice(1).join('/');
+    }
+
+    getDescription(): string {
+        return this.entry.data.description as string;
+    }
+
+    getOrder(): number {
+        return this.entry.data.order ?? 0;
+    }
+
+    async getTopDoc(): Promise<CourseDoc | null> {
+        const id = this.getTopDocId();
+        const doc = await courseRepo.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 courseRepo.find(id);
+        return doc;
+    }
+
+    async getChildren(): Promise<CourseDoc[]> {
+        const debug = false;
+        const children = (await courseRepo.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;
+    }
+
+    getBadge(): string {
+        return this.entry.data.badge ?? '';
+    }
+
+    getCategory(): string {
+        return this.entry.data.category ?? '';
+    }
+
+    getTags(): string[] {
+        return this.entry.data.tags ?? [];
+    }
+
+    getLink(): string {
+        return LinkUtil.getCourseLink(this.entry.id);
+    }
+
+    getDate(): Date {
+        return new Date(this.entry.data.date as Date);
+    }
+
+    getDateForDisplay() {
+        try {
+            const dateObj = new Date(this.entry.data.date as Date);
+            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';
+        }
+    }
+
+    async render(): Promise<any> {
+        return await render(this.entry);
+    }
+
+    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(),
+        });
+    }
+
+    hasTag(tag: string): boolean {
+        return this.getTags().includes(tag);
+    }
+
+    hasBadge(): boolean {
+        return this.getBadge() !== '';
+    }
+
+    isBook(): boolean {
+        return this.entry.id.split('/').length === 2;
+    }
+
+    isDraft(): boolean {
+        return this.entry.data.draft ?? false;
+    }
+
+    isHidden(): boolean {
+        return this.entry.data.hidden ?? false;
+    }
+
+    isNotHidden(): boolean {
+        return !this.isHidden();
+    }
+
+    isFolder(): boolean {
+        return this.entry.data.folder ?? false;
+    }
+
+    isFamous(): boolean {
+        return this.entry.data.famous ?? false;
+    }
+
+    async toSidebarItem(): Promise<SidebarItemEntity> {
+        const debug = false;
+        const children = await this.getChildren();
+        let childItems = await Promise.all(
+            children
+                .filter((child) => child.isNotHidden())
+                .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(),
+            badge: this.entry.data.badge,
+        });
+    }
+}