@coffic/cosy-ui 0.9.3 → 0.9.5

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(),
-    });
-  }
-}

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

@@ -1,93 +0,0 @@
-import { SidebarItemEntity } from './SidebarItem';
-import type { MetaEntry } from '../database/MetaDB';
-import { LinkUtil } from '../../src/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: '',
-    });
-  }
-}

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

@@ -1,42 +0,0 @@
-import { blogDB } from '../database/BlogDB';
-import { SidebarItemEntity } from './SidebarItem';
-import { type ITagStaticPath } from '../types/static-path';
-import { LinkUtil } from '../../src/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(): ITagStaticPath {
-    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;