@coffic/cosy-ui 0.9.4 → 0.9.5

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

@@ -1,207 +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/src-astro/entities/BlogDoc.ts

@@ -1,107 +0,0 @@
-import type { BlogEntry } from '../database/BlogDB';
-import { LinkUtil } from '../../src/utils/link';
-import Tag from './Tag';
-import { BaseDoc } from './BaseDoc';
-import { COLLECTION_BLOG } from '../database/BlogDB';
-import { blogDB } from '../database/BlogDB';
-
-/**
- * 博客文档类，配合 BlogDB 使用
- *
- * 目录结构：
- * ```
- * 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 子模块独立管理
- *
- * 相关：
- * - BlogDB：博客数据库管理类，负责博客文档的增删查改
- * - BlogDoc：博客文档实体类，封装单篇博客的相关操作
- *
- * 用法示例：
- * ```typescript
- * import BlogDoc from '../entities/BlogDoc';
- * import { blogDB } from '../database/BlogDB';
- *
- * // 获取所有中文博客
- * const blogs = await blogDB.allBlogsByLang('zh-cn');
- *
- * // 获取博客链接
- * const link = blogs[0].getLink();
- * ```
- */
-
-export default class BlogDoc extends BaseDoc<
-  typeof COLLECTION_BLOG,
-  BlogEntry
-> {
-  private constructor(entry: BlogEntry) {
-    super(entry);
-  }
-
-  static fromEntry(entry: BlogEntry) {
-    return new BlogDoc(entry);
-  }
-
-  async getTopDoc(): Promise<BlogDoc | null> {
-    const id = this.getTopDocId();
-    const doc = await blogDB.find(id);
-    return doc;
-  }
-
-  async getChildren(): Promise<BlogDoc[]> {
-    return await blogDB.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);
-
-      // 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/src-astro/entities/CourseDoc.ts

@@ -1,102 +0,0 @@
-import { cosyLogger } from '../cosy';
-import { SidebarItemEntity } from './SidebarItem';
-import type { CourseEntry } from '../database/CourseDB';
-import { courseDB } from '../database/CourseDB';
-import { LinkUtil } from '../../src/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 ?? 0;
-    }
-
-    isFolder(): boolean {
-        return this.entry.data.folder ?? false;
-    }
-
-    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(),
-            badge: this.entry.data.badge,
-        });
-    }
-
-    isBook(): boolean {
-        return this.entry.id.split('/').length === 2;
-    }
-}

package/dist/src-astro/entities/ExperimentDoc.ts

@@ -1,119 +0,0 @@
-import type { ExperimentEntry } from '../database/ExperimentDB';
-import { experimentDB } from '../database/ExperimentDB';
-import { cosyLogger } from '../cosy';
-import { SidebarItemEntity } from './SidebarItem';
-import { LinkUtil } from '../../src/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/src-astro/entities/LessonDoc.ts

@@ -1,153 +0,0 @@
-import type { LessonEntry } from '../database/LessonDB';
-import { lessonDB } from '../database/LessonDB';
-import { cosyLogger } from '../cosy';
-import { SidebarItemEntity } from './SidebarItem';
-import { LinkUtil } from '../../src/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(),
-    });
-  }
-}