@interactive-inc/docs-client 0.0.4 → 0.0.6

package/build/values/doc-front-matter-index-value.js

@@ -0,0 +1,185 @@
+import { parse, stringify } from "yaml";
+import { zDocFileIndexFrontMatter } from "../models";
+import { DocSchemaValue } from "../values/doc-schema-value";
+import { DocSchemaFieldFactory } from "./doc-schema-field-factory";
+/**
+ * FrontMatter
+ */
+export class DocFrontMatterIndexValue {
+    value;
+    constructor(value) {
+        this.value = value;
+        zDocFileIndexFrontMatter.parse(value);
+        Object.freeze(this);
+    }
+    /**
+     * アイコンを取得
+     */
+    get icon() {
+        return this.value.icon;
+    }
+    /**
+     * スキーマを取得
+     */
+    get schema() {
+        return new DocSchemaValue(this.value.schema);
+    }
+    /**
+     * iconフィールドを更新
+     */
+    withIcon(value) {
+        if (typeof value !== "string") {
+            return this;
+        }
+        const currentData = this.toJson();
+        return DocFrontMatterIndexValue.fromRecord({
+            ...currentData,
+            icon: value,
+        });
+    }
+    /**
+     * schemaフィールドを更新
+     */
+    withSchema(value) {
+        if (typeof value !== "object" || value === null) {
+            return this;
+        }
+        const currentData = this.toJson();
+        return DocFrontMatterIndexValue.fromRecord({
+            ...currentData,
+            schema: DocFrontMatterIndexValue.createSchema(value),
+        });
+    }
+    /**
+     * JSON形式で出力
+     */
+    toJson() {
+        return this.value;
+    }
+    /**
+     * YAML形式で出力
+     */
+    toYaml() {
+        // iconとschemaのみを明示的に出力
+        const yamlData = {
+            icon: this.value.icon,
+            schema: this.value.schema,
+        };
+        return stringify(yamlData).trim();
+    }
+    /**
+     * スキーマ全体を正規化
+     */
+    static createSchema(schema) {
+        if (typeof schema !== "object" || schema === null) {
+            return {};
+        }
+        const schemaObj = schema;
+        const record = {};
+        for (const [key, value] of Object.entries(schemaObj)) {
+            const normalizedField = DocFrontMatterIndexValue.createSchemaField(key, value);
+            if (normalizedField === null)
+                continue;
+            record[key] = normalizedField;
+        }
+        return record;
+    }
+    /**
+     * スキーマフィールドを正規化
+     */
+    static createSchemaField(key, value) {
+        try {
+            const factory = new DocSchemaFieldFactory();
+            const fieldValue = factory.fromUnknown(key, value);
+            return fieldValue.toJson();
+        }
+        catch {
+            return null;
+        }
+    }
+    /**
+     * Markdownテキストから生成（不完全なデータも処理可能）
+     */
+    static from(markdownText) {
+        // FrontMatterセクションを抽出
+        if (!markdownText.startsWith("---")) {
+            return DocFrontMatterIndexValue.empty();
+        }
+        const endIndex = markdownText.indexOf("\n---", 3);
+        if (endIndex === -1) {
+            return DocFrontMatterIndexValue.empty();
+        }
+        const frontMatterText = markdownText.slice(4, endIndex).trim();
+        try {
+            // YAMLをパース
+            const data = parse(frontMatterText) || {};
+            return DocFrontMatterIndexValue.fromRecord(data);
+        }
+        catch {
+            return DocFrontMatterIndexValue.empty();
+        }
+    }
+    /**
+     * データから直接生成（不完全なデータも処理可能）
+     */
+    static fromRecord(record) {
+        if (typeof record !== "object") {
+            return DocFrontMatterIndexValue.empty();
+        }
+        const icon = DocFrontMatterIndexValue.extractIcon(record);
+        const schema = DocFrontMatterIndexValue.extractSchema(record);
+        const frontMatter = {
+            type: "index-frontmatter",
+            icon,
+            schema,
+        };
+        try {
+            const validated = zDocFileIndexFrontMatter.parse(frontMatter);
+            return new DocFrontMatterIndexValue(validated);
+        }
+        catch {
+            return DocFrontMatterIndexValue.empty();
+        }
+    }
+    /**
+     * 空のFrontMatterを生成
+     */
+    static empty() {
+        return new DocFrontMatterIndexValue({
+            type: "index-frontmatter",
+            icon: "",
+            schema: {},
+        });
+    }
+    /**
+     * アイコンを抽出
+     */
+    static extractIcon(data) {
+        if ("icon" in data && typeof data.icon === "string") {
+            return data.icon;
+        }
+        return DocFrontMatterIndexValue.getDefaultIcon();
+    }
+    /**
+     * スキーマを抽出
+     */
+    static extractSchema(data) {
+        const hasSchema = "schema" in data;
+        if (!hasSchema) {
+            return {};
+        }
+        if (typeof data.schema !== "object") {
+            return {};
+        }
+        if (data.schema === null) {
+            return {};
+        }
+        return DocFrontMatterIndexValue.createSchema(data.schema);
+    }
+    /**
+     * デフォルトのアイコンを取得
+     */
+    static getDefaultIcon() {
+        return "📃";
+    }
+}

package/build/values/doc-front-matter-index-value.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=doc-front-matter-index-value.test.d.ts.map

package/build/values/doc-front-matter-index-value.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-front-matter-index-value.test.d.ts","sourceRoot":"","sources":["../../lib/values/doc-front-matter-index-value.test.ts"],"names":[],"mappings":""}

package/build/values/doc-front-matter-index-value.test.js

@@ -0,0 +1,98 @@
+import { expect, test } from "bun:test";
+import { DocFrontMatterIndexValue } from "./doc-front-matter-index-value";
+test("DocFrontMatterIndexValue - 基本的な作成とプロパティアクセス", () => {
+    const value = new DocFrontMatterIndexValue({
+        type: "index-frontmatter",
+        icon: "📁",
+        schema: {
+            name: {
+                type: "text",
+                required: true,
+                title: "名前",
+                description: "項目の名前",
+                default: "",
+            },
+            age: {
+                type: "number",
+                required: false,
+                title: "年齢",
+                description: "年齢の数値",
+                default: 0,
+            },
+        },
+    });
+    expect(value.icon).toBe("📁");
+    const schema = value.schema.toJson();
+    expect(schema.name?.type).toBe("text");
+    expect(schema.name?.required).toBe(true);
+    expect(schema.age?.type).toBe("number");
+    expect(schema.age?.required).toBe(false);
+});
+test("DocFrontMatterIndexValue - 空のschemaの場合", () => {
+    const value = new DocFrontMatterIndexValue({
+        type: "index-frontmatter",
+        icon: "",
+        schema: {},
+    });
+    expect(value.icon).toBe("");
+    expect(value.schema.toJson()).toEqual({});
+});
+test("DocFrontMatterIndexValue - toYamlでYAML文字列を生成", () => {
+    const value = new DocFrontMatterIndexValue({
+        type: "index-frontmatter",
+        icon: "📂",
+        schema: {
+            title: {
+                type: "text",
+                required: true,
+                title: "タイトル",
+                description: "ドキュメントのタイトル",
+                default: "",
+            },
+        },
+    });
+    const yaml = value.toYaml();
+    expect(yaml).toContain("icon: 📂");
+    expect(yaml).toContain("schema:");
+    expect(yaml).toContain("title:");
+    expect(yaml).toContain("type: text");
+    expect(yaml).toContain("required: true");
+});
+test("DocFrontMatterIndexValue - 空のiconとschemaでtoYaml", () => {
+    const value = new DocFrontMatterIndexValue({
+        type: "index-frontmatter",
+        icon: "",
+        schema: {},
+    });
+    const yaml = value.toYaml();
+    expect(yaml).toContain('icon: ""');
+    expect(yaml).toContain("schema: {}");
+});
+test("DocFrontMatterIndexValue - toJsonで元のデータ構造を返す", () => {
+    const data = {
+        type: "index-frontmatter",
+        icon: "📁",
+        schema: {
+            name: {
+                type: "text",
+                required: true,
+                title: "名前",
+                description: "項目の名前",
+                default: "",
+            },
+        },
+    };
+    const value = new DocFrontMatterIndexValue(data);
+    expect(value.toJson()).toEqual(data);
+});
+test("DocFrontMatterIndexValue - 不変性の確認", () => {
+    const value = new DocFrontMatterIndexValue({
+        type: "index-frontmatter",
+        icon: "📁",
+        schema: {},
+    });
+    expect(() => {
+        // @ts-expect-error - 不変性のテスト
+        value.value = {};
+    }).toThrow();
+});

package/build/values/doc-front-matter-md-value-accessor.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=doc-front-matter-md-value-accessor.test.d.ts.map

package/build/values/doc-front-matter-md-value-accessor.test.d.ts.map

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

package/build/values/doc-front-matter-md-value-accessor.test.js

@@ -0,0 +1,226 @@
+import { expect, test } from "bun:test";
+import { DocFrontMatterMdValue } from "./doc-front-matter-md-value";
+test("text メソッドは文字列型の値のみを返す", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        title: "正しいタイトル",
+        count: 123,
+        flag: true,
+        list: ["item1", "item2"],
+        obj: { key: "value" },
+        nullable: null,
+    });
+    // 文字列型は正しく取得
+    expect(frontMatter.text("title")).toBe("正しいタイトル");
+    // 他の型はnullを返す
+    expect(frontMatter.text("count")).toBeNull();
+    expect(frontMatter.text("flag")).toBeNull();
+    expect(frontMatter.text("list")).toBeNull();
+    expect(frontMatter.text("obj")).toBeNull();
+    expect(frontMatter.text("nullable")).toBeNull();
+    expect(frontMatter.text("missing")).toBeNull();
+});
+test("number メソッドは数値型の値のみを返す", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        count: 42,
+        price: 99.99,
+        title: "文字列",
+        flag: false,
+        list: [1, 2, 3],
+    });
+    // 数値型は正しく取得
+    expect(frontMatter.number("count")).toBe(42);
+    expect(frontMatter.number("price")).toBe(99.99);
+    // 他の型はnullを返す
+    expect(frontMatter.number("title")).toBeNull();
+    expect(frontMatter.number("flag")).toBeNull();
+    expect(frontMatter.number("list")).toBeNull();
+});
+test("boolean メソッドは真偽値型の値のみを返す", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        published: true,
+        draft: false,
+        title: "文字列",
+        count: 0,
+        zero: 0,
+        empty: "",
+    });
+    // 真偽値型は正しく取得
+    expect(frontMatter.boolean("published")).toBe(true);
+    expect(frontMatter.boolean("draft")).toBe(false);
+    // 他の型はnullを返す（0や空文字列も）
+    expect(frontMatter.boolean("title")).toBeNull();
+    expect(frontMatter.boolean("count")).toBeNull();
+    expect(frontMatter.boolean("zero")).toBeNull();
+    expect(frontMatter.boolean("empty")).toBeNull();
+});
+test("relation メソッドは文字列型の値を返す（単一リレーション）", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        author: "user-123",
+        category: "tech-blog",
+        tags: ["tag1", "tag2"],
+        count: 123,
+    });
+    // 文字列型のリレーションは正しく取得
+    expect(frontMatter.relation("author")).toBe("user-123");
+    expect(frontMatter.relation("category")).toBe("tech-blog");
+    // 配列や他の型はnullを返す
+    expect(frontMatter.relation("tags")).toBeNull();
+    expect(frontMatter.relation("count")).toBeNull();
+});
+test("multiRelation メソッドは文字列配列のみを返す", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        features: ["login", "logout", "signup"],
+        tags: ["tech", "tutorial", "beginner"],
+        emptyArray: [],
+        singleString: "not-array",
+        numberArray: [1, 2, 3],
+    });
+    // 文字列配列は正しく取得
+    expect(frontMatter.multiRelation("features")).toEqual([
+        "login",
+        "logout",
+        "signup",
+    ]);
+    expect(frontMatter.multiRelation("tags")).toEqual([
+        "tech",
+        "tutorial",
+        "beginner",
+    ]);
+    expect(frontMatter.multiRelation("emptyArray")).toEqual([]);
+    // 単一値や数値配列は空配列を返す
+    expect(frontMatter.multiRelation("singleString")).toEqual([]);
+    expect(frontMatter.multiRelation("numberArray")).toEqual([]);
+    expect(frontMatter.multiRelation("missing")).toEqual([]);
+});
+test("multiText メソッドは文字列配列を返す", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        keywords: ["typescript", "javascript", "nodejs"],
+        authors: ["alice", "bob", "charlie"],
+        empty: [],
+        notArray: "single-value",
+    });
+    // 文字列配列は正しく取得
+    expect(frontMatter.multiText("keywords")).toEqual([
+        "typescript",
+        "javascript",
+        "nodejs",
+    ]);
+    expect(frontMatter.multiText("authors")).toEqual(["alice", "bob", "charlie"]);
+    expect(frontMatter.multiText("empty")).toEqual([]);
+    // 非配列は空配列を返す
+    expect(frontMatter.multiText("notArray")).toEqual([]);
+    expect(frontMatter.multiText("missing")).toEqual([]);
+});
+test("multiNumber メソッドは数値配列のみを返す", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        scores: [85, 90, 78],
+        prices: [19.99, 29.99, 39.99],
+        empty: [],
+        stringArray: ["1", "2", "3"],
+        singleNumber: 42,
+    });
+    // 数値配列は正しく取得
+    expect(frontMatter.multiNumber("scores")).toEqual([85, 90, 78]);
+    expect(frontMatter.multiNumber("prices")).toEqual([19.99, 29.99, 39.99]);
+    expect(frontMatter.multiNumber("empty")).toEqual([]);
+    // 文字列配列や単一値は空配列を返す
+    expect(frontMatter.multiNumber("stringArray")).toEqual([]);
+    expect(frontMatter.multiNumber("singleNumber")).toEqual([]);
+    expect(frontMatter.multiNumber("missing")).toEqual([]);
+});
+test("multiBoolean メソッドは真偽値配列のみを返す", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        flags: [true, false, true, true],
+        permissions: [false, false],
+        empty: [],
+        stringArray: ["true", "false"],
+        singleBool: true,
+    });
+    // 真偽値配列は正しく取得
+    expect(frontMatter.multiBoolean("flags")).toEqual([true, false, true, true]);
+    expect(frontMatter.multiBoolean("permissions")).toEqual([false, false]);
+    expect(frontMatter.multiBoolean("empty")).toEqual([]);
+    // 文字列配列や単一値は空配列を返す
+    expect(frontMatter.multiBoolean("stringArray")).toEqual([]);
+    expect(frontMatter.multiBoolean("singleBool")).toEqual([]);
+    expect(frontMatter.multiBoolean("missing")).toEqual([]);
+});
+test("has メソッドはプロパティの存在を正しく判定", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        title: "タイトル",
+        count: 0,
+        flag: false,
+        empty: "",
+        nullable: null,
+        list: [],
+    });
+    // 値が存在すればtrueを返す（falsy値でも）
+    expect(frontMatter.has("title")).toBe(true);
+    expect(frontMatter.has("count")).toBe(true);
+    expect(frontMatter.has("flag")).toBe(true);
+    expect(frontMatter.has("empty")).toBe(true);
+    expect(frontMatter.has("nullable")).toBe(true);
+    expect(frontMatter.has("list")).toBe(true);
+    // 存在しないキーはfalse
+    expect(frontMatter.has("missing")).toBe(false);
+    expect(frontMatter.has("notDefined")).toBe(false);
+});
+test("keys ゲッターはすべてのキーを返す", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        title: "テスト",
+        version: 1.0,
+        published: true,
+        tags: ["tag1", "tag2"],
+    });
+    const keys = frontMatter.keys;
+    expect(keys).toHaveLength(4);
+    expect(keys).toContain("title");
+    expect(keys).toContain("version");
+    expect(keys).toContain("published");
+    expect(keys).toContain("tags");
+    // 順序は保証されないので、セットで比較
+    expect(new Set(keys)).toEqual(new Set(["title", "version", "published", "tags"]));
+});
+test("特殊なケース：存在しないキーへのアクセス", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        title: "テスト",
+    });
+    expect(frontMatter.has("title")).toBe(true);
+    expect(frontMatter.has("undefinedValue")).toBe(false);
+    expect(frontMatter.text("undefinedValue")).toBeNull();
+});
+test("型の厳密な検証：文字列の数値は数値として扱われない", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        stringNumber: "123",
+        stringBool: "true",
+        actualNumber: 123,
+        actualBool: true,
+    });
+    // 文字列の"123"は数値として取得できない
+    expect(frontMatter.number("stringNumber")).toBeNull();
+    expect(frontMatter.text("stringNumber")).toBe("123");
+    // 文字列の"true"は真偽値として取得できない
+    expect(frontMatter.boolean("stringBool")).toBeNull();
+    expect(frontMatter.text("stringBool")).toBe("true");
+    // 実際の数値と真偽値は正しく取得
+    expect(frontMatter.number("actualNumber")).toBe(123);
+    expect(frontMatter.boolean("actualBool")).toBe(true);
+});
+test("ネストしたオブジェクトは適切に扱われる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        meta: {
+            author: "John",
+            version: 1.0,
+        },
+        config: {
+            enabled: true,
+            settings: ["a", "b"],
+        },
+    });
+    // ネストしたオブジェクトは文字列や他の型として取得できない
+    expect(frontMatter.text("meta")).toBeNull();
+    expect(frontMatter.text("config")).toBeNull();
+    // ただし、存在はする
+    expect(frontMatter.has("meta")).toBe(true);
+    expect(frontMatter.has("config")).toBe(true);
+});

package/build/values/doc-front-matter-md-value.d.ts

@@ -0,0 +1,80 @@
+import type { DocFileMdFrontMatter } from "../types";
+import type { DocSchemaValue } from "./doc-schema-value";
+/**
+ * FrontMatter
+ */
+export declare class DocFrontMatterMdValue {
+    readonly value: DocFileMdFrontMatter;
+    constructor(value: DocFileMdFrontMatter);
+    toJson(): DocFileMdFrontMatter;
+    toYaml(): string;
+    /**
+     * Markdownテキストから生成
+     */
+    static from(markdownText: string): DocFrontMatterMdValue;
+    /**
+     * 空のFrontMatterを生成
+     */
+    static empty(): DocFrontMatterMdValue;
+    /**
+     * データから直接生成
+     */
+    static fromData(data: unknown): DocFrontMatterMdValue;
+    /**
+     * スキーマフィールドに基づいてデフォルト値を生成する
+     */
+    static generateDefaultValueFromSchemaField(fieldDef: {
+        type: string;
+        default?: unknown;
+    }): unknown;
+    /**
+     * 単一のプロパティを更新した新しいインスタンスを返す
+     * スキーマに基づいて型を検証し、スキーマのフィールドのみを含む新しいインスタンスを生成
+     */
+    withProperty(key: string, value: unknown, schema: DocSchemaValue): DocFrontMatterMdValue;
+    /**
+     * フィールド値の検証
+     */
+    private validateFieldValue;
+    /**
+     * テキスト型のプロパティを取得
+     */
+    text(key: string): string | null;
+    /**
+     * 数値型のプロパティを取得
+     */
+    number(key: string): number | null;
+    /**
+     * 真偽値型のプロパティを取得
+     */
+    boolean(key: string): boolean | null;
+    /**
+     * 単一リレーション型のプロパティを取得
+     */
+    relation(key: string): string | null;
+    /**
+     * 複数リレーション型のプロパティを取得
+     */
+    multiRelation(key: string): string[];
+    /**
+     * 複数テキスト型のプロパティを取得
+     */
+    multiText(key: string): string[];
+    /**
+     * 複数数値型のプロパティを取得
+     */
+    multiNumber(key: string): number[];
+    /**
+     * 複数真偽値型のプロパティを取得
+     */
+    multiBoolean(key: string): boolean[];
+    /**
+     * プロパティが存在するかチェック
+     */
+    has(key: string): boolean;
+    /**
+     * すべてのキーを取得
+     */
+    get keys(): string[];
+}
+//# sourceMappingURL=doc-front-matter-md-value.d.ts.map

package/build/values/doc-front-matter-md-value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-front-matter-md-value.d.ts","sourceRoot":"","sources":["../../lib/values/doc-front-matter-md-value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAIV,oBAAoB,EAIrB,MAAM,UAAU,CAAA;AAUjB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAA;AAExD;;GAEG;AACH,qBAAa,qBAAqB;IACpB,QAAQ,CAAC,KAAK,EAAE,oBAAoB;IAAhD,YAAqB,KAAK,EAAE,oBAAoB,EAG/C;IAED,MAAM,IAAI,oBAAoB,CAE7B;IAED,MAAM,IAAI,MAAM,CAEf;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,MAAM,GAAG,qBAAqB,CAQvD;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,IAAI,qBAAqB,CAEpC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,GAAG,qBAAqB,CAGpD;IAED;;OAEG;IACH,MAAM,CAAC,mCAAmC,CAAC,QAAQ,EAAE;QACnD,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE,OAAO,CAAA;KAClB,GAAG,OAAO,CAsBV;IAED;;;OAGG;IACH,YAAY,CACV,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,cAAc,GACrB,qBAAqB,CA4CvB;IAED;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAc1B;;OAEG;IACH,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAU/B;IAED;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAUjC;IAED;;OAEG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAYnC;IAED;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAWnC;IAED;;OAEG;IACH,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAYnC;IAED;;OAEG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAY/B;IAED;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAYjC;IAED;;OAEG;IACH,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,EAAE,CAYnC;IAED;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAExB;IAED;;OAEG;IACH,IAAI,IAAI,IAAI,MAAM,EAAE,CAEnB;CACF"}