@interactive-inc/docs-client 0.0.4 → 0.0.6

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

@@ -0,0 +1,77 @@
+import { expect, test } from "bun:test";
+import { DocFileIndexReference } from "./doc-file-index-reference";
+import { DocFileSystemDebug } from "./doc-file-system-debug";
+import { DocFileIndexEntity } from "./entities/doc-file-index-entity";
+test("DocFileIndexReference - writeメソッドがフロントマターを含む完全なテキストを書き込む", async () => {
+    const fileSystem = DocFileSystemDebug.createWithFiles({
+        fileContents: {
+            "docs/products/features/index.md": [
+                "---",
+                "icon: 📄",
+                "schema:",
+                "  milestone:",
+                "    type: relation",
+                "    required: false",
+                "    title: マイルストーン",
+                "    path: products/milestones",
+                "---",
+                "",
+                "# 機能",
+                "",
+                "機能の説明",
+            ].join("\n"),
+        },
+    });
+    const ref = new DocFileIndexReference({
+        path: "products/features/index.md",
+        fileSystem,
+        pathSystem: fileSystem.getPathSystem(),
+    });
+    // 既存のエンティティを読み込む
+    const entity = await ref.read();
+    expect(entity).toBeInstanceOf(DocFileIndexEntity);
+    // タイトルを更新
+    const updatedEntity = entity.withContent(entity.content.withTitle("新しいタイトル"));
+    // ファイルに書き込む
+    await ref.write(updatedEntity);
+    // ファイルの内容を確認
+    const writtenContent = fileSystem.getFileContent("docs/products/features/index.md");
+    expect(writtenContent).toBeTruthy();
+    // フロントマターが保持されていることを確認
+    expect(writtenContent).toContain("---");
+    expect(writtenContent).toContain("icon: 📄");
+    expect(writtenContent).toContain("schema:");
+    expect(writtenContent).toContain("type: relation");
+    // タイトルが更新されていることを確認
+    expect(writtenContent).toContain("# 新しいタイトル");
+    // typeフィールドが含まれていないことを確認
+    expect(writtenContent).not.toContain("type: index-frontmatter");
+});
+test("DocFileIndexReference - readメソッドが正しくエンティティを返す", async () => {
+    const fileSystem = DocFileSystemDebug.createWithFiles({
+        fileContents: {
+            "docs/index.md": [
+                "---",
+                "icon: 📚",
+                "schema: {}",
+                "---",
+                "",
+                "# ドキュメント",
+                "",
+                "説明文",
+            ].join("\n"),
+        },
+    });
+    const ref = new DocFileIndexReference({
+        path: "docs/index.md",
+        fileSystem,
+        pathSystem: fileSystem.getPathSystem(),
+    });
+    const entity = await ref.read();
+    expect(entity).toBeInstanceOf(DocFileIndexEntity);
+    // コンテンツの確認
+    expect(entity.content.title).toBe("ドキュメント");
+    expect(entity.content.description).toBe("説明文");
+    expect(entity.content.frontMatter.value.icon).toBe("📚");
+    expect(entity.content.frontMatter.value.schema).toEqual({});
+});

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

@@ -0,0 +1,97 @@
+import { DocDirectoryReference } from "./doc-directory-reference";
+import type { DocFileSystem } from "./doc-file-system";
+import type { DocPathSystem } from "./doc-path-system";
+import { DocFileMdEntity } from "./entities/doc-file-md-entity";
+type Props = {
+    path: string;
+    fileSystem: DocFileSystem;
+    pathSystem: DocPathSystem;
+};
+/**
+ * ファイルの参照
+ */
+export declare class DocFileMdReference {
+    private readonly props;
+    private readonly pathSystem;
+    constructor(props: Props);
+    get fileSystem(): DocFileSystem;
+    get basePath(): string;
+    get path(): string;
+    get fullPath(): string;
+    get directoryPath(): string;
+    get archivedPath(): string;
+    get name(): string;
+    get nameWithExtension(): string;
+    directory(): DocDirectoryReference;
+    read(): Promise<Error | DocFileMdEntity>;
+    /**
+     * ファイルの内容を読み込む
+     */
+    readContent(): Promise<Error | string>;
+    /**
+     * ファイルに内容を書き込む
+     */
+    writeContent(content: string): Promise<void>;
+    /**
+     * Entityを書き込む
+     */
+    write(entity: DocFileMdEntity): Promise<void>;
+    /**
+     * 新しいファイルをデフォルトコンテンツで作成
+     */
+    writeDefault(): Promise<void>;
+    /**
+     * ファイルを削除
+     */
+    delete(): Promise<Error | null>;
+    /**
+     * ファイルが存在するか確認（アーカイブも含む）
+     */
+    exists(): Promise<boolean>;
+    /**
+     * ファイルをコピー
+     */
+    copyTo(destinationPath: string): Promise<void>;
+    /**
+     * ファイルを移動
+     */
+    moveTo(destinationPath: string): Promise<void>;
+    /**
+     * ファイルのサイズを取得（バイト単位）
+     */
+    size(): Promise<number>;
+    /**
+     * ファイルの最終更新日時を取得
+     */
+    lastModified(): Promise<Date>;
+    /**
+     * ファイルの作成日時を取得
+     */
+    createdAt(): Promise<Date>;
+    /**
+     * ファイルをアーカイブに移動し、新しい参照を返す
+     */
+    archive(archiveDirectoryName?: string): Promise<DocFileMdReference>;
+    /**
+     * ファイルをアーカイブから復元し、新しい参照を返す
+     */
+    restore(archiveDirectoryName?: string): Promise<DocFileMdReference>;
+    /**
+     * スキーマに基づいてリレーションを取得する
+     */
+    relation(key: string): Promise<DocFileMdReference | Error | null>;
+    /**
+     * 同じディレクトリのindex.mdを取得する
+     */
+    getDirectoryIndex(): Promise<DocFileMdEntity | null>;
+    /**
+     * 複数のリレーションを取得する
+     */
+    relations(key: string): Promise<DocFileMdReference[]>;
+    /**
+     * スキーマに基づいて複数のリレーションを取得する
+     */
+    multiRelation(key: string): Promise<DocFileMdReference[]>;
+}
+export {};
+//# sourceMappingURL=doc-file-md-reference.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"doc-file-md-reference.d.ts","sourceRoot":"","sources":["../lib/doc-file-md-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAA;AACjE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACtD,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAM/D,KAAK,KAAK,GAAG;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,UAAU,EAAE,aAAa,CAAA;IACzB,UAAU,EAAE,aAAa,CAAA;CAC1B,CAAA;AAED;;GAEG;AACH,qBAAa,kBAAkB;IAGjB,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,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,aAAa,IAAI,MAAM,CAE1B;IAED,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED,IAAI,IAAI,IAAI,MAAM,CAEjB;IAED,IAAI,iBAAiB,IAAI,MAAM,CAE9B;IAED,SAAS,IAAI,qBAAqB,CAQjC;IAEK,IAAI,IAAI,OAAO,CAAC,KAAK,GAAG,eAAe,CAAC,CA4C7C;IAED;;OAEG;IACG,WAAW,IAAI,OAAO,CAAC,KAAK,GAAG,MAAM,CAAC,CAM3C;IAED;;OAEG;IACG,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjD;IAED;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAGlD;IAED;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAQlC;IAED;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAEpC;IAED;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,OAAO,CAAC,CAY/B;IAED;;OAEG;IACG,MAAM,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEnD;IAED;;OAEG;IACG,MAAM,CAAC,eAAe,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAEnD;IAED;;OAEG;IACG,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAE5B;IAED;;OAEG;IACG,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC,CAElC;IAED;;OAEG;IACG,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAE/B;IAED;;OAEG;IACG,OAAO,CAAC,oBAAoB,SAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAkBrE;IAED;;OAEG;IACG,OAAO,CAAC,oBAAoB,SAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAyBrE;IAED;;OAEG;IACG,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,KAAK,GAAG,IAAI,CAAC,CA2CtE;IAED;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,eAAe,GAAG,IAAI,CAAC,CAczD;IAED;;OAEG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAE1D;IAED;;OAEG;IACG,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CA6C9D;CACF"}

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

@@ -0,0 +1,297 @@
+import { DocDirectoryReference } from "./doc-directory-reference";
+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 { DocSchemaValue } from "./values/doc-schema-value";
+/**
+ * ファイルの参照
+ */
+export class DocFileMdReference {
+    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.path;
+    }
+    get fullPath() {
+        return this.pathSystem.join(this.basePath, this.path);
+    }
+    get directoryPath() {
+        return this.pathSystem.dirname(this.path);
+    }
+    get archivedPath() {
+        return this.pathSystem.join(this.directoryPath, "_", this.nameWithExtension);
+    }
+    get name() {
+        return this.pathSystem.basename(this.path, ".md");
+    }
+    get nameWithExtension() {
+        return `${this.name}.md`;
+    }
+    directory() {
+        return new DocDirectoryReference({
+            archiveDirectoryName: "_",
+            indexFileName: "index.md",
+            fileSystem: this.fileSystem,
+            path: this.directoryPath,
+            pathSystem: this.pathSystem,
+        });
+    }
+    async read() {
+        const content = await this.fileSystem.readFile(this.path);
+        const actualPath = this.path;
+        if (content === null) {
+            const content = await this.fileSystem.readFile(this.archivedPath);
+            if (content !== null) {
+                const contentValue = DocFileContentMdValue.fromMarkdown(content);
+                const pathValue = DocFilePathValue.fromPathWithSystem(actualPath, this.pathSystem, this.basePath);
+                return new DocFileMdEntity({
+                    type: "markdown",
+                    content: contentValue.value,
+                    path: pathValue.value,
+                    isArchived: true,
+                });
+            }
+        }
+        if (content === null) {
+            return new Error(`File not found at ${this.path} or in archive.`);
+        }
+        const contentValue = DocFileContentMdValue.fromMarkdown(content);
+        const pathValue = DocFilePathValue.fromPathWithSystem(actualPath, this.pathSystem, this.basePath);
+        // アーカイブディレクトリにあるファイルかどうかをチェック
+        const isInArchiveDir = this.path.includes("/_/") || this.path.startsWith("_/");
+        return new DocFileMdEntity({
+            type: "markdown",
+            content: contentValue.value,
+            path: pathValue.value,
+            isArchived: isInArchiveDir,
+        });
+    }
+    /**
+     * ファイルの内容を読み込む
+     */
+    async readContent() {
+        const entity = await this.read();
+        if (entity instanceof Error) {
+            return entity;
+        }
+        return entity.value.content.body;
+    }
+    /**
+     * ファイルに内容を書き込む
+     */
+    async writeContent(content) {
+        return await this.fileSystem.writeFile(this.path, content);
+    }
+    /**
+     * Entityを書き込む
+     */
+    async write(entity) {
+        const content = entity.content.toText();
+        return await this.fileSystem.writeFile(this.path, content);
+    }
+    /**
+     * 新しいファイルをデフォルトコンテンツで作成
+     */
+    async writeDefault() {
+        const fileName = this.pathSystem.basename(this.path, ".md");
+        const defaultContent = [
+            `# ${fileName}`,
+            "",
+            "ここに内容を記載してください。",
+        ].join("\n");
+        return await this.fileSystem.writeFile(this.path, defaultContent);
+    }
+    /**
+     * ファイルを削除
+     */
+    async delete() {
+        return await this.fileSystem.deleteFile(this.path);
+    }
+    /**
+     * ファイルが存在するか確認（アーカイブも含む）
+     */
+    async exists() {
+        // まず通常のパスを確認
+        if (await this.fileSystem.exists(this.path)) {
+            return true;
+        }
+        // アーカイブディレクトリを確認
+        const dirPath = this.pathSystem.dirname(this.path);
+        const fileName = this.pathSystem.basename(this.path);
+        const archivePath = this.pathSystem.join(dirPath, "_", fileName);
+        return this.fileSystem.exists(archivePath);
+    }
+    /**
+     * ファイルをコピー
+     */
+    async copyTo(destinationPath) {
+        await this.fileSystem.copyFile(this.path, destinationPath);
+    }
+    /**
+     * ファイルを移動
+     */
+    async moveTo(destinationPath) {
+        await this.fileSystem.moveFile(this.path, destinationPath);
+    }
+    /**
+     * ファイルのサイズを取得（バイト単位）
+     */
+    async size() {
+        return this.fileSystem.getFileSize(this.path);
+    }
+    /**
+     * ファイルの最終更新日時を取得
+     */
+    async lastModified() {
+        return this.fileSystem.getFileModifiedTime(this.path);
+    }
+    /**
+     * ファイルの作成日時を取得
+     */
+    async createdAt() {
+        return this.fileSystem.getFileCreatedTime(this.path);
+    }
+    /**
+     * ファイルをアーカイブに移動し、新しい参照を返す
+     */
+    async archive(archiveDirectoryName = "_") {
+        const dirPath = this.pathSystem.dirname(this.path);
+        const fileName = this.pathSystem.basename(this.path);
+        const archivePath = this.pathSystem.join(dirPath, archiveDirectoryName, fileName);
+        await this.moveTo(archivePath);
+        return new DocFileMdReference({
+            path: archivePath,
+            fileSystem: this.fileSystem,
+            pathSystem: this.pathSystem,
+        });
+    }
+    /**
+     * ファイルをアーカイブから復元し、新しい参照を返す
+     */
+    async restore(archiveDirectoryName = "_") {
+        const dirPath = this.pathSystem.dirname(this.path);
+        const parentDirName = this.pathSystem.basename(dirPath);
+        if (parentDirName !== archiveDirectoryName) {
+            throw new Error(`ファイルはアーカイブディレクトリにありません: ${this.path}`);
+        }
+        const fileName = this.pathSystem.basename(this.path);
+        const restorePath = this.pathSystem.join(this.pathSystem.dirname(dirPath), fileName);
+        await this.moveTo(restorePath);
+        return new DocFileMdReference({
+            path: restorePath,
+            fileSystem: this.fileSystem,
+            pathSystem: this.pathSystem,
+        });
+    }
+    /**
+     * スキーマに基づいてリレーションを取得する
+     */
+    async relation(key) {
+        const file = await this.read();
+        if (file instanceof Error) {
+            return file;
+        }
+        // FrontMatterからリレーション値を取得
+        const relationValue = file.content.frontMatter.relation(key);
+        if (relationValue === null) {
+            return null;
+        }
+        // 同じディレクトリのindex.mdを取得
+        const indexFile = await this.getDirectoryIndex();
+        if (!indexFile) {
+            return null;
+        }
+        const schemaData = indexFile.content.frontMatter.value.schema;
+        if (!schemaData ||
+            typeof schemaData !== "object" ||
+            Array.isArray(schemaData)) {
+            return null;
+        }
+        const schema = new DocSchemaValue(schemaData);
+        const field = schema.field(key);
+        // リレーションフィールドでない場合はnull
+        if (!field || !("path" in field) || !field.path) {
+            return null;
+        }
+        // スキーマで定義されたパスとリレーション値を組み合わせる
+        const fullPath = this.pathSystem.join(field.path, `${relationValue}.md`);
+        return new DocFileMdReference({
+            path: fullPath,
+            fileSystem: this.fileSystem,
+            pathSystem: this.pathSystem,
+        });
+    }
+    /**
+     * 同じディレクトリのindex.mdを取得する
+     */
+    async getDirectoryIndex() {
+        const indexPath = this.pathSystem.join(this.directoryPath, "index.md");
+        const indexRef = new DocFileMdReference({
+            path: indexPath,
+            fileSystem: this.fileSystem,
+            pathSystem: this.pathSystem,
+        });
+        const indexFile = await indexRef.read();
+        if (indexFile instanceof Error) {
+            return null;
+        }
+        return indexFile;
+    }
+    /**
+     * 複数のリレーションを取得する
+     */
+    async relations(key) {
+        return this.multiRelation(key);
+    }
+    /**
+     * スキーマに基づいて複数のリレーションを取得する
+     */
+    async multiRelation(key) {
+        const file = await this.read();
+        if (file instanceof Error) {
+            return [];
+        }
+        // FrontMatterから複数リレーション値を取得
+        const relationValues = file.content.frontMatter.multiRelation(key);
+        if (relationValues.length === 0) {
+            return [];
+        }
+        // 同じディレクトリのindex.mdを取得
+        const indexFile = await this.getDirectoryIndex();
+        if (!indexFile) {
+            return [];
+        }
+        const schemaData = indexFile.content.frontMatter.value.schema;
+        if (!schemaData ||
+            typeof schemaData !== "object" ||
+            Array.isArray(schemaData)) {
+            return [];
+        }
+        const schema = new DocSchemaValue(schemaData);
+        const field = schema.field(key);
+        // リレーションフィールドでない場合は空配列
+        if (!field || !("path" in field) || !field.path) {
+            return [];
+        }
+        // 各リレーション値に対してDocFileMdReferenceを作成
+        return relationValues.map((relationValue) => {
+            const fullPath = this.pathSystem.join(field.path, `${relationValue}.md`);
+            return new DocFileMdReference({
+                path: fullPath,
+                fileSystem: this.fileSystem,
+                pathSystem: this.pathSystem,
+            });
+        });
+    }
+}

package/build/doc-file-md-reference.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=doc-file-md-reference.test.d.ts.map

package/build/doc-file-md-reference.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-file-md-reference.test.d.ts","sourceRoot":"","sources":["../lib/doc-file-md-reference.test.ts"],"names":[],"mappings":""}