@interactive-inc/docs-client 0.0.5 → 0.0.7

package/build/doc-file-md-reference.test.js

@@ -1,465 +0,0 @@
-import { expect, test } from "bun:test";
-import { DocFileMdReference } from "./doc-file-md-reference";
-import { DocFileSystemDebug } from "./doc-file-system-debug";
-import { DocPathSystem } from "./doc-path-system";
-import { DocFileMdEntity } from "./entities/doc-file-md-entity";
-import { DocFilePathValue } from "./values/doc-file-path-value";
-test("DocFileMdReference - writeメソッドがフロントマターを含む完全なテキストを書き込む", async () => {
-    const fileSystem = DocFileSystemDebug.createWithFiles({
-        fileContents: {
-            "docs/products/entities/user-entity.md": [
-                "---",
-                "type: entity",
-                "title: ユーザー",
-                "---",
-                "",
-                "# ユーザー",
-                "",
-                "ユーザーの説明",
-            ].join("\n"),
-        },
-    });
-    const ref = new DocFileMdReference({
-        path: "docs/products/entities/user-entity.md",
-        fileSystem,
-        pathSystem: fileSystem.getPathSystem(),
-    });
-    // 既存のエンティティを読み込む
-    const entity = await ref.read();
-    if (entity instanceof Error) {
-        throw entity;
-    }
-    expect(entity).toBeInstanceOf(DocFileMdEntity);
-    // タイトルを更新
-    const updatedEntity = entity.withContent(entity.content.withTitle("新しいタイトル"));
-    // ファイルに書き込む
-    await ref.write(updatedEntity);
-    // ファイルの内容を確認
-    const writtenContent = fileSystem.getFileContent("docs/products/entities/user-entity.md");
-    expect(writtenContent).toBeTruthy();
-    // フロントマターが保持されていることを確認
-    expect(writtenContent).toContain("---");
-    expect(writtenContent).toContain("type: entity");
-    expect(writtenContent).toContain("title: ユーザー");
-    // タイトルが更新されていることを確認
-    expect(writtenContent).toContain("# 新しいタイトル");
-});
-test("DocFileMdReference - readメソッドが正しくエンティティを返す", async () => {
-    const fileSystem = DocFileSystemDebug.createWithFiles({
-        fileContents: {
-            "docs/features/login.md": [
-                "---",
-                "type: feature",
-                "status: in-progress",
-                "---",
-                "",
-                "# ログイン機能",
-                "",
-                "ユーザーがシステムにログインする機能",
-            ].join("\n"),
-        },
-    });
-    const ref = new DocFileMdReference({
-        path: "docs/features/login.md",
-        fileSystem,
-        pathSystem: fileSystem.getPathSystem(),
-    });
-    const entity = await ref.read();
-    if (entity instanceof Error) {
-        throw entity;
-    }
-    expect(entity).toBeInstanceOf(DocFileMdEntity);
-    // コンテンツの確認
-    expect(entity.content.title).toBe("ログイン機能");
-    // bodyにはタイトルと説明が含まれる
-    expect(entity.content.body).toBe("# ログイン機能\n\nユーザーがシステムにログインする機能");
-    expect(entity.content.description).toBe("ユーザーがシステムにログインする機能");
-    expect(entity.content.frontMatter.value.type).toBe("feature");
-    expect(entity.content.frontMatter.value.status).toBe("in-progress");
-});
-test("DocFileMdReference - 新規ファイルの作成", async () => {
-    const fileSystem = DocFileSystemDebug.createWithFiles({});
-    const ref = new DocFileMdReference({
-        path: "docs/products/values/price-value.md",
-        fileSystem,
-        pathSystem: fileSystem.getPathSystem(),
-    });
-    // 新しいエンティティを作成
-    const pathValue = DocFilePathValue.fromPathWithSystem("docs/products/values/price-value.md", fileSystem.getPathSystem());
-    const entity = new DocFileMdEntity({
-        type: "markdown",
-        path: pathValue.value,
-        content: {
-            type: "markdown-content",
-            title: "価格",
-            body: "# 価格\n\n商品の価格を表す値オブジェクト",
-            description: "商品の価格を表す値オブジェクト",
-            frontMatter: {
-                value: {
-                    type: "value-object",
-                    attributes: ["amount", "currency"],
-                },
-            },
-        },
-        isArchived: false,
-    });
-    // ファイルに書き込む
-    await ref.write(entity);
-    // ファイルの内容を確認
-    const writtenContent = fileSystem.getFileContent("docs/products/values/price-value.md");
-    expect(writtenContent).toBeTruthy();
-    // 内容の確認
-    expect(writtenContent).toContain("---");
-    expect(writtenContent).toContain("type: value-object");
-    // YAMLの配列は複数行形式で出力される
-    expect(writtenContent).toContain("attributes:");
-    expect(writtenContent).toContain("- amount");
-    expect(writtenContent).toContain("- currency");
-    expect(writtenContent).toContain("# 価格");
-    expect(writtenContent).toContain("商品の価格を表す値オブジェクト");
-});
-// リレーション関連のテスト
-test("getDirectoryIndex メソッドはディレクトリのindex.mdを返す", async () => {
-    const files = {
-        "products/doc-browser/pages/index.md": `---
-schema:
-  features:
-    type: multi-relation
-    path: docs/products/doc-browser/features
-    required: false
-    title: Features
-    description: List of features
-    default: []
----
-# Pages`,
-        "products/doc-browser/pages/home.md": `---
-features:
-  - list-documents
-  - create-document
----
-# Home Page`,
-    };
-    const pathSystem = new DocPathSystem();
-    const mockFileSystem = {
-        getBasePath: () => "",
-        readFile: async (path) => {
-            // アーカイブチェックも含む
-            if (files[path])
-                return files[path];
-            // アーカイブパスをチェック
-            const dirPath = pathSystem.dirname(path);
-            const fileName = pathSystem.basename(path);
-            const archivePath = pathSystem.join(dirPath, "_", fileName);
-            return files[archivePath] || null;
-        },
-        exists: async (path) => path in files,
-        pathSystem,
-    };
-    const fileSystem = mockFileSystem;
-    const fileRef = new DocFileMdReference({
-        path: "products/doc-browser/pages/home.md",
-        fileSystem: fileSystem,
-        pathSystem: pathSystem,
-    });
-    const indexFile = await fileRef.getDirectoryIndex();
-    expect(indexFile).not.toBeNull();
-    expect(indexFile?.content.frontMatter.value.schema).toBeDefined();
-});
-test("getDirectoryIndex メソッドはindex.mdがない場合nullを返す", async () => {
-    const files = {
-        "products/doc-browser/pages/home.md": `# Home Page`,
-    };
-    const pathSystem = new DocPathSystem();
-    const mockFileSystem = {
-        getBasePath: () => "",
-        readFile: async (path) => {
-            // アーカイブチェックも含む
-            if (files[path])
-                return files[path];
-            // アーカイブパスをチェック
-            const dirPath = pathSystem.dirname(path);
-            const fileName = pathSystem.basename(path);
-            const archivePath = pathSystem.join(dirPath, "_", fileName);
-            return files[archivePath] || null;
-        },
-        exists: async (path) => path in files,
-        pathSystem,
-    };
-    const fileSystem = mockFileSystem;
-    const fileRef = new DocFileMdReference({
-        path: "products/doc-browser/pages/home.md",
-        fileSystem: fileSystem,
-        pathSystem: pathSystem,
-    });
-    const indexFile = await fileRef.getDirectoryIndex();
-    expect(indexFile).toBeNull();
-});
-test("relation メソッドはスキーマに基づいてリレーションを解決する", async () => {
-    const files = {
-        "products/doc-browser/pages/index.md": `---
-schema:
-  author:
-    type: relation
-    path: users
-    required: false
-    title: Author
-    description: Document author
-    default: null
----
-# Pages`,
-        "products/doc-browser/pages/home.md": `---
-author: john-doe
----
-# Home Page`,
-        "users/john-doe.md": `# John Doe`,
-    };
-    const pathSystem = new DocPathSystem();
-    const mockFileSystem = {
-        getBasePath: () => "",
-        readFile: async (path) => {
-            // アーカイブチェックも含む
-            if (files[path])
-                return files[path];
-            // アーカイブパスをチェック
-            const dirPath = pathSystem.dirname(path);
-            const fileName = pathSystem.basename(path);
-            const archivePath = pathSystem.join(dirPath, "_", fileName);
-            return files[archivePath] || null;
-        },
-        exists: async (path) => path in files,
-        pathSystem,
-    };
-    const fileSystem = mockFileSystem;
-    const fileRef = new DocFileMdReference({
-        path: "products/doc-browser/pages/home.md",
-        fileSystem: fileSystem,
-        pathSystem: pathSystem,
-    });
-    const relationRef = await fileRef.relation("author");
-    expect(relationRef).not.toBeNull();
-    expect(relationRef).not.toBeInstanceOf(Error);
-    if (relationRef && !(relationRef instanceof Error)) {
-        expect(relationRef.path).toBe("users/john-doe.md");
-        const relationFile = await relationRef.read();
-        expect(relationFile).not.toBeInstanceOf(Error);
-        if (!(relationFile instanceof Error)) {
-            expect(relationFile.content.title).toBe("John Doe");
-        }
-    }
-});
-test("relation メソッドはスキーマがない場合nullを返す", async () => {
-    const files = {
-        "products/doc-browser/pages/home.md": `---
-author: users/john-doe
----
-# Home Page`,
-        "users/john-doe.md": `# John Doe`,
-    };
-    const pathSystem = new DocPathSystem();
-    const mockFileSystem = {
-        getBasePath: () => "",
-        readFile: async (path) => {
-            // アーカイブチェックも含む
-            if (files[path])
-                return files[path];
-            // アーカイブパスをチェック
-            const dirPath = pathSystem.dirname(path);
-            const fileName = pathSystem.basename(path);
-            const archivePath = pathSystem.join(dirPath, "_", fileName);
-            return files[archivePath] || null;
-        },
-        exists: async (path) => path in files,
-        pathSystem,
-    };
-    const fileSystem = mockFileSystem;
-    const fileRef = new DocFileMdReference({
-        path: "products/doc-browser/pages/home.md",
-        fileSystem: fileSystem,
-        pathSystem: pathSystem,
-    });
-    const relationRef = await fileRef.relation("author");
-    expect(relationRef).toBeNull();
-});
-test("multiRelation メソッドは複数のリレーションを解決する", async () => {
-    const files = {
-        "products/doc-browser/pages/index.md": `---
-schema:
-  features:
-    type: multi-relation
-    path: docs/products/doc-browser/features
-    required: false
-    title: Features
-    description: List of features
-    default: []
----
-# Pages`,
-        "products/doc-browser/pages/home.md": `---
-features:
-  - list-documents
-  - create-document
-  - delete-document
----
-# Home Page`,
-        "docs/products/doc-browser/features/list-documents.md": `# List Documents`,
-        "docs/products/doc-browser/features/create-document.md": `# Create Document`,
-        "docs/products/doc-browser/features/delete-document.md": `# Delete Document`,
-    };
-    const pathSystem = new DocPathSystem();
-    const mockFileSystem = {
-        getBasePath: () => "",
-        readFile: async (path) => {
-            // アーカイブチェックも含む
-            if (files[path])
-                return files[path];
-            // アーカイブパスをチェック
-            const dirPath = pathSystem.dirname(path);
-            const fileName = pathSystem.basename(path);
-            const archivePath = pathSystem.join(dirPath, "_", fileName);
-            return files[archivePath] || null;
-        },
-        exists: async (path) => path in files,
-        pathSystem,
-    };
-    const fileSystem = mockFileSystem;
-    const fileRef = new DocFileMdReference({
-        path: "products/doc-browser/pages/home.md",
-        fileSystem: fileSystem,
-        pathSystem: pathSystem,
-    });
-    const relationRefs = await fileRef.multiRelation("features");
-    expect(relationRefs).toHaveLength(3);
-    expect(relationRefs[0].path).toBe("docs/products/doc-browser/features/list-documents.md");
-    expect(relationRefs[1].path).toBe("docs/products/doc-browser/features/create-document.md");
-    expect(relationRefs[2].path).toBe("docs/products/doc-browser/features/delete-document.md");
-});
-test("multiRelation メソッドは空のリレーションで空配列を返す", async () => {
-    const files = {
-        "products/doc-browser/pages/index.md": `---
-schema:
-  features:
-    type: multi-relation
-    path: docs/products/doc-browser/features
-    required: false
-    title: Features
-    description: List of features
-    default: []
----
-# Pages`,
-        "products/doc-browser/pages/home.md": `---
-features: []
----
-# Home Page`,
-    };
-    const pathSystem = new DocPathSystem();
-    const mockFileSystem = {
-        getBasePath: () => "",
-        readFile: async (path) => {
-            // アーカイブチェックも含む
-            if (files[path])
-                return files[path];
-            // アーカイブパスをチェック
-            const dirPath = pathSystem.dirname(path);
-            const fileName = pathSystem.basename(path);
-            const archivePath = pathSystem.join(dirPath, "_", fileName);
-            return files[archivePath] || null;
-        },
-        exists: async (path) => path in files,
-        pathSystem,
-    };
-    const fileSystem = mockFileSystem;
-    const fileRef = new DocFileMdReference({
-        path: "products/doc-browser/pages/home.md",
-        fileSystem: fileSystem,
-        pathSystem: pathSystem,
-    });
-    const relationRefs = await fileRef.multiRelation("features");
-    expect(relationRefs).toEqual([]);
-});
-test("relation メソッドはリレーションフィールドでない場合nullを返す", async () => {
-    const files = {
-        "products/doc-browser/pages/index.md": `---
-schema:
-  title:
-    type: text
-    required: true
-    title: Title
-    description: Page title
-    default: ""
----
-# Pages`,
-        "products/doc-browser/pages/home.md": `---
-title: ホームページ
----
-# Home Page`,
-    };
-    const pathSystem = new DocPathSystem();
-    const mockFileSystem = {
-        getBasePath: () => "",
-        readFile: async (path) => {
-            // アーカイブチェックも含む
-            if (files[path])
-                return files[path];
-            // アーカイブパスをチェック
-            const dirPath = pathSystem.dirname(path);
-            const fileName = pathSystem.basename(path);
-            const archivePath = pathSystem.join(dirPath, "_", fileName);
-            return files[archivePath] || null;
-        },
-        exists: async (path) => path in files,
-        pathSystem,
-    };
-    const fileSystem = mockFileSystem;
-    const fileRef = new DocFileMdReference({
-        path: "products/doc-browser/pages/home.md",
-        fileSystem: fileSystem,
-        pathSystem: pathSystem,
-    });
-    const relationRef = await fileRef.relation("title");
-    expect(relationRef).toBeNull();
-});
-test("index.mdがアーカイブにある場合も取得できる", async () => {
-    const files = {
-        "products/doc-browser/pages/_/index.md": `---
-schema:
-  features:
-    type: multi-relation
-    path: docs/products/doc-browser/features
-    required: false
-    title: Features
-    description: List of features
-    default: []
----
-# Pages (Archived)`,
-        "products/doc-browser/pages/home.md": `---
-features:
-  - list-documents
----
-# Home Page`,
-    };
-    const pathSystem = new DocPathSystem();
-    const mockFileSystem = {
-        getBasePath: () => "",
-        readFile: async (path) => {
-            // アーカイブチェックも含む
-            if (files[path])
-                return files[path];
-            // アーカイブパスをチェック
-            const dirPath = pathSystem.dirname(path);
-            const fileName = pathSystem.basename(path);
-            const archivePath = pathSystem.join(dirPath, "_", fileName);
-            return files[archivePath] || null;
-        },
-        exists: async (path) => path in files,
-        pathSystem,
-    };
-    const fileSystem = mockFileSystem;
-    const fileRef = new DocFileMdReference({
-        path: "products/doc-browser/pages/home.md",
-        fileSystem: fileSystem,
-        pathSystem: pathSystem,
-    });
-    const indexFile = await fileRef.getDirectoryIndex();
-    expect(indexFile).not.toBeNull();
-    // アーカイブのindex.mdが取得できることを確認
-    expect(indexFile?.content.frontMatter.value.schema).toBeDefined();
-});

package/build/doc-file-relation-reference.d.ts

@@ -1,54 +0,0 @@
-import type { DocFileSystem } from "./doc-file-system";
-import type { DocPathSystem } from "./doc-path-system";
-import { DocRelationFileValue } from "./values/doc-relation-file-value";
-import { DocRelationValue } from "./values/doc-relation-value";
-type Props = {
-    filePath: string;
-    fileSystem: DocFileSystem;
-    pathSystem: DocPathSystem;
-};
-/**
- * リレーションファイルの参照
- */
-export declare class DocFileRelationReference {
-    private readonly props;
-    private readonly pathSystem;
-    constructor(props: Props);
-    get fileSystem(): DocFileSystem;
-    get basePath(): string;
-    /**
-     * リレーションパス
-     */
-    get path(): string;
-    /**
-     * フルパス
-     */
-    get fullPath(): string;
-    read(): Promise<DocRelationValue | null>;
-    /**
-     * リレーションファイルの一覧を読み込む
-     */
-    readFiles(): Promise<DocRelationFileValue[]>;
-    /**
-     * 単一のリレーションファイルを読み込む
-     */
-    readFile(filePath: string): Promise<DocRelationFileValue | null>;
-    /**
-     * ファイルの存在確認
-     */
-    exists(slug: string): Promise<boolean>;
-    /**
-     * ファイル名の一覧を取得（拡張子なし）
-     */
-    readSlugs(): Promise<string[]>;
-    /**
-     * ファイル数を取得
-     */
-    count(): Promise<number>;
-    /**
-     * 空かどうかを確認
-     */
-    isEmpty(): Promise<boolean>;
-}
-export {};
-//# sourceMappingURL=doc-file-relation-reference.d.ts.map

package/build/doc-file-relation-reference.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"doc-file-relation-reference.d.ts","sourceRoot":"","sources":["../lib/doc-file-relation-reference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AAKtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAA;AACvE,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAA;AAE9D,KAAK,KAAK,GAAG;IACX,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,aAAa,CAAA;IACzB,UAAU,EAAE,aAAa,CAAA;CAC1B,CAAA;AAED;;GAEG;AACH,qBAAa,wBAAwB;IAGvB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAFlC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;IAE1C,YAA6B,KAAK,EAAE,KAAK,EAGxC;IAED,IAAI,UAAU,IAAI,aAAa,CAE9B;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAKrB;IAEK,IAAI,IAAI,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAO7C;IAED;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC,CAkBjD;IAED;;OAEG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAyBrE;IAED;;OAEG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAG3C;IAED;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC,CAGnC;IAED;;OAEG;IACG,KAAK,IAAI,OAAO,CAAC,MAAM,CAAC,CAG7B;IAED;;OAEG;IACG,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAGhC;CACF"}

package/build/doc-file-relation-reference.js

@@ -1,109 +0,0 @@
-import { DocFileMdEntity } from "./entities/doc-file-md-entity";
-import { DocFileContentMdValue } from "./values/doc-file-content-md-value";
-import { DocFilePathValue } from "./values/doc-file-path-value";
-import { DocRelationFileValue } from "./values/doc-relation-file-value";
-import { DocRelationValue } from "./values/doc-relation-value";
-/**
- * リレーションファイルの参照
- */
-export class DocFileRelationReference {
-    props;
-    pathSystem;
-    constructor(props) {
-        this.props = props;
-        this.pathSystem = props.pathSystem;
-        Object.freeze(this);
-    }
-    get fileSystem() {
-        return this.props.fileSystem;
-    }
-    get basePath() {
-        return this.fileSystem.getBasePath();
-    }
-    /**
-     * リレーションパス
-     */
-    get path() {
-        return this.props.filePath;
-    }
-    /**
-     * フルパス
-     */
-    get fullPath() {
-        return this.pathSystem.join(this.fileSystem.getBasePath(), this.props.filePath);
-    }
-    async read() {
-        const files = await this.readFiles();
-        return new DocRelationValue({
-            path: this.path,
-            files: files.map((value) => value.toJson()),
-        });
-    }
-    /**
-     * リレーションファイルの一覧を読み込む
-     */
-    async readFiles() {
-        const exists = await this.fileSystem.exists(this.path);
-        if (!exists) {
-            return [];
-        }
-        const filePaths = await this.fileSystem.readDirectoryFilePaths(this.path);
-        const files = [];
-        for (const filePath of filePaths) {
-            const file = await this.readFile(filePath);
-            if (file === null)
-                continue;
-            files.push(file);
-        }
-        return files;
-    }
-    /**
-     * 単一のリレーションファイルを読み込む
-     */
-    async readFile(filePath) {
-        if (filePath.includes("index.md")) {
-            return null;
-        }
-        const content = await this.fileSystem.readFile(filePath);
-        if (content === null) {
-            return null;
-        }
-        const contentValue = DocFileContentMdValue.fromMarkdown(content);
-        const pathValue = DocFilePathValue.fromPathWithSystem(filePath, this.pathSystem, this.basePath);
-        const fileEntity = new DocFileMdEntity({
-            type: "markdown",
-            content: contentValue.value,
-            path: pathValue.value,
-            isArchived: false,
-        });
-        return DocRelationFileValue.from(filePath, fileEntity.value.content.title);
-    }
-    /**
-     * ファイルの存在確認
-     */
-    async exists(slug) {
-        const filePath = `${this.path}/${slug}.md`;
-        return this.fileSystem.exists(filePath);
-    }
-    /**
-     * ファイル名の一覧を取得（拡張子なし）
-     */
-    async readSlugs() {
-        const files = await this.readFiles();
-        return files.map((file) => file.id);
-    }
-    /**
-     * ファイル数を取得
-     */
-    async count() {
-        const files = await this.readFiles();
-        return files.length;
-    }
-    /**
-     * 空かどうかを確認
-     */
-    async isEmpty() {
-        const count = await this.count();
-        return count === 0;
-    }
-}