@interactive-inc/docs-client 0.0.3 → 0.0.5

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

@@ -0,0 +1,257 @@
+import { stringify } from "yaml";
+import { zDocFileMdFrontMatter } from "../models";
+import { DocContentMdValue } from "./doc-content-md-value";
+import { DocSchemaFieldBooleanMultipleValue } from "./doc-schema-field-boolean-multiple-value";
+import { DocSchemaFieldBooleanSingleValue } from "./doc-schema-field-boolean-single-value";
+import { DocSchemaFieldFactory } from "./doc-schema-field-factory";
+import { DocSchemaFieldNumberMultipleValue } from "./doc-schema-field-number-multiple-value";
+import { DocSchemaFieldNumberSingleValue } from "./doc-schema-field-number-single-value";
+import { DocSchemaFieldTextMultipleValue } from "./doc-schema-field-text-multiple-value";
+import { DocSchemaFieldTextSingleValue } from "./doc-schema-field-text-single-value";
+/**
+ * FrontMatter
+ */
+export class DocFrontMatterMdValue {
+    value;
+    constructor(value) {
+        this.value = value;
+        zDocFileMdFrontMatter.parse(value);
+        Object.freeze(this);
+    }
+    toJson() {
+        return this.value;
+    }
+    toYaml() {
+        return stringify(this.value).trim();
+    }
+    /**
+     * Markdownテキストから生成
+     */
+    static from(markdownText) {
+        const openMarkdown = new DocContentMdValue(markdownText);
+        const rawData = openMarkdown.frontMatter.data || {};
+        const data = zDocFileMdFrontMatter.parse(rawData);
+        return new DocFrontMatterMdValue(data);
+    }
+    /**
+     * 空のFrontMatterを生成
+     */
+    static empty() {
+        return new DocFrontMatterMdValue({});
+    }
+    /**
+     * データから直接生成
+     */
+    static fromData(data) {
+        const validatedData = zDocFileMdFrontMatter.parse(data);
+        return new DocFrontMatterMdValue(validatedData);
+    }
+    /**
+     * スキーマフィールドに基づいてデフォルト値を生成する
+     */
+    static generateDefaultValueFromSchemaField(fieldDef) {
+        if (fieldDef.type === "text") {
+            return fieldDef.default ?? "";
+        }
+        if (fieldDef.type === "boolean") {
+            return fieldDef.default ?? false;
+        }
+        if (fieldDef.type === "number") {
+            return fieldDef.default ?? 0;
+        }
+        if (fieldDef.type === "multi-text" ||
+            fieldDef.type === "multi-number" ||
+            fieldDef.type === "multi-boolean" ||
+            fieldDef.type === "multi-relation") {
+            return fieldDef.default ?? [];
+        }
+        if (fieldDef.type === "relation") {
+            return fieldDef.default ?? null;
+        }
+        return null;
+    }
+    /**
+     * 単一のプロパティを更新した新しいインスタンスを返す
+     * スキーマに基づいて型を検証し、スキーマのフィールドのみを含む新しいインスタンスを生成
+     */
+    withProperty(key, value, schema) {
+        const currentData = this.toJson();
+        const fieldValue = schema.field(key);
+        if (fieldValue === null) {
+            return this;
+        }
+        if (!this.validateFieldValue(key, value, fieldValue)) {
+            return this;
+        }
+        // スキーマを元にFrontMatterを再構築
+        const draft = {};
+        for (const field of schema.fields) {
+            const fieldKey = field.key;
+            if (fieldKey === key) {
+                // 更新対象のフィールドは新しい値を使用
+                // valueは事前にvalidateFieldValueで検証済み
+                draft[fieldKey] = value;
+            }
+            else if (fieldKey in currentData) {
+                // 既存の値があればそれを使用
+                const value = currentData[fieldKey];
+                if (value !== undefined) {
+                    draft[fieldKey] = value;
+                }
+            }
+            else {
+                // 値がない場合はデフォルト値を使用
+                draft[fieldKey] = field.toJson().default;
+            }
+        }
+        return new DocFrontMatterMdValue(draft);
+    }
+    /**
+     * フィールド値の検証
+     */
+    validateFieldValue(key, value, fieldDef) {
+        try {
+            const factory = new DocSchemaFieldFactory();
+            const schemaField = factory.fromSchemaEntry(key, fieldDef);
+            return schemaField.validate(value);
+        }
+        catch {
+            return false;
+        }
+    }
+    /**
+     * テキスト型のプロパティを取得
+     */
+    text(key) {
+        const value = this.value[key];
+        const validator = new DocSchemaFieldTextSingleValue(key, {
+            type: "text",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+        return validator.validate(value) && typeof value === "string" ? value : null;
+    }
+    /**
+     * 数値型のプロパティを取得
+     */
+    number(key) {
+        const value = this.value[key];
+        const validator = new DocSchemaFieldNumberSingleValue(key, {
+            type: "number",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+        return validator.validate(value) && typeof value === "number" ? value : null;
+    }
+    /**
+     * 真偽値型のプロパティを取得
+     */
+    boolean(key) {
+        const value = this.value[key];
+        const validator = new DocSchemaFieldBooleanSingleValue(key, {
+            type: "boolean",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+        return validator.validate(value) && typeof value === "boolean"
+            ? value
+            : null;
+    }
+    /**
+     * 単一リレーション型のプロパティを取得
+     */
+    relation(key) {
+        const value = this.value[key];
+        // リレーションもテキスト型と同じバリデーション
+        const validator = new DocSchemaFieldTextSingleValue(key, {
+            type: "text",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+        return validator.validate(value) && typeof value === "string" ? value : null;
+    }
+    /**
+     * 複数リレーション型のプロパティを取得
+     */
+    multiRelation(key) {
+        const value = this.value[key];
+        const validator = new DocSchemaFieldTextMultipleValue(key, {
+            type: "multi-text",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+        return validator.validate(value) && Array.isArray(value)
+            ? value
+            : [];
+    }
+    /**
+     * 複数テキスト型のプロパティを取得
+     */
+    multiText(key) {
+        const value = this.value[key];
+        const validator = new DocSchemaFieldTextMultipleValue(key, {
+            type: "multi-text",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+        return validator.validate(value) && Array.isArray(value)
+            ? value
+            : [];
+    }
+    /**
+     * 複数数値型のプロパティを取得
+     */
+    multiNumber(key) {
+        const value = this.value[key];
+        const validator = new DocSchemaFieldNumberMultipleValue(key, {
+            type: "multi-number",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+        return validator.validate(value) && Array.isArray(value)
+            ? value
+            : [];
+    }
+    /**
+     * 複数真偽値型のプロパティを取得
+     */
+    multiBoolean(key) {
+        const value = this.value[key];
+        const validator = new DocSchemaFieldBooleanMultipleValue(key, {
+            type: "multi-boolean",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+        return validator.validate(value) && Array.isArray(value)
+            ? value
+            : [];
+    }
+    /**
+     * プロパティが存在するかチェック
+     */
+    has(key) {
+        return key in this.value && this.value[key] !== undefined;
+    }
+    /**
+     * すべてのキーを取得
+     */
+    get keys() {
+        return Object.keys(this.value);
+    }
+}

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

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

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

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

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

@@ -0,0 +1,198 @@
+import { expect, test } from "bun:test";
+import { DocFrontMatterMdValue } from "./doc-front-matter-md-value";
+test("DocFrontMatterMdValue - 基本的な作成とプロパティアクセス", () => {
+    const value = new DocFrontMatterMdValue({
+        title: "ドキュメントタイトル",
+        description: "ドキュメントの説明",
+        tags: ["tag1", "tag2"],
+        author: "作者名",
+    });
+    expect(value.value.title).toBe("ドキュメントタイトル");
+    expect(value.value.description).toBe("ドキュメントの説明");
+    expect(value.value.tags).toEqual(["tag1", "tag2"]);
+    expect(value.value.author).toBe("作者名");
+});
+test("DocFrontMatterMdValue - 空のFrontMatter", () => {
+    const value = new DocFrontMatterMdValue({});
+    expect(value.value).toEqual({});
+});
+test("DocFrontMatterMdValue - 一部のフィールドのみ", () => {
+    const value = new DocFrontMatterMdValue({
+        title: "タイトルのみ",
+    });
+    expect(value.value.title).toBe("タイトルのみ");
+    expect(value.value.description).toBeUndefined();
+    expect(value.value.tags).toBeUndefined();
+});
+test("DocFrontMatterMdValue - toYamlでYAML文字列を生成", () => {
+    const value = new DocFrontMatterMdValue({
+        title: "タイトル",
+        tags: ["tag1", "tag2"],
+    });
+    const yaml = value.toYaml();
+    expect(yaml).toContain("title: タイトル");
+    expect(yaml).toContain("tags:");
+    expect(yaml).toContain("  - tag1");
+    expect(yaml).toContain("  - tag2");
+});
+test("DocFrontMatterMdValue - 空のFrontMatterでtoYaml", () => {
+    const value = new DocFrontMatterMdValue({});
+    const yaml = value.toYaml();
+    expect(yaml).toBe("{}");
+});
+test("DocFrontMatterMdValue - 特殊文字を含む値でtoYaml", () => {
+    const value = new DocFrontMatterMdValue({
+        title: "タイトル with \"quotes\" and 'apostrophes'",
+        description: "説明文\n改行あり",
+    });
+    const yaml = value.toYaml();
+    expect(yaml).toContain("title:");
+    expect(yaml).toContain("description:");
+    // YAMLライブラリが適切にエスケープすることを確認
+});
+test("DocFrontMatterMdValue - toJsonで元のデータ構造を返す", () => {
+    const data = {
+        title: "タイトル",
+        tags: ["tag1"],
+        custom: "カスタムフィールド",
+    };
+    const value = new DocFrontMatterMdValue(data);
+    expect(value.toJson()).toEqual(data);
+});
+test("DocFrontMatterMdValue - 不変性の確認", () => {
+    const value = new DocFrontMatterMdValue({
+        title: "タイトル",
+    });
+    expect(() => {
+        // @ts-expect-error - 不変性のテスト
+        value.value = {};
+    }).toThrow();
+});
+test("text メソッドでテキスト型の値を取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        title: "テストタイトル",
+        description: "説明文",
+        count: 42,
+    });
+    expect(frontMatter.text("title")).toBe("テストタイトル");
+    expect(frontMatter.text("description")).toBe("説明文");
+    expect(frontMatter.text("count")).toBeNull(); // 数値型なのでnull
+    expect(frontMatter.text("missing")).toBeNull(); // 存在しないキー
+});
+test("number メソッドで数値型の値を取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        count: 42,
+        version: 1.5,
+        title: "テスト",
+    });
+    expect(frontMatter.number("count")).toBe(42);
+    expect(frontMatter.number("version")).toBe(1.5);
+    expect(frontMatter.number("title")).toBeNull(); // 文字列型なのでnull
+    expect(frontMatter.number("missing")).toBeNull();
+});
+test("boolean メソッドで真偽値型の値を取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        published: true,
+        draft: false,
+        title: "テスト",
+    });
+    expect(frontMatter.boolean("published")).toBe(true);
+    expect(frontMatter.boolean("draft")).toBe(false);
+    expect(frontMatter.boolean("title")).toBeNull();
+    expect(frontMatter.boolean("missing")).toBeNull();
+});
+test("relation メソッドで単一リレーションを取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        author: "user-123",
+        category: "tech",
+        tags: ["tag1", "tag2"],
+    });
+    expect(frontMatter.relation("author")).toBe("user-123");
+    expect(frontMatter.relation("category")).toBe("tech");
+    expect(frontMatter.relation("tags")).toBeNull(); // 配列なのでnull
+    expect(frontMatter.relation("missing")).toBeNull();
+});
+test("multiRelation メソッドで複数リレーションを取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        features: ["login", "logout", "signup"],
+        tags: ["tech", "tutorial"],
+        single: "value",
+    });
+    expect(frontMatter.multiRelation("features")).toEqual([
+        "login",
+        "logout",
+        "signup",
+    ]);
+    expect(frontMatter.multiRelation("tags")).toEqual(["tech", "tutorial"]);
+    expect(frontMatter.multiRelation("single")).toEqual([]); // 単一値なので空配列
+    expect(frontMatter.multiRelation("missing")).toEqual([]);
+});
+test("multiText メソッドで複数テキストを取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        keywords: ["typescript", "javascript", "nodejs"],
+        authors: ["alice", "bob"],
+    });
+    expect(frontMatter.multiText("keywords")).toEqual([
+        "typescript",
+        "javascript",
+        "nodejs",
+    ]);
+    expect(frontMatter.multiText("authors")).toEqual(["alice", "bob"]);
+    expect(frontMatter.multiText("missing")).toEqual([]);
+});
+test("multiNumber メソッドで複数数値を取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        scores: [85, 90, 78],
+        versions: [1.0, 1.1, 2.0],
+    });
+    expect(frontMatter.multiNumber("scores")).toEqual([85, 90, 78]);
+    expect(frontMatter.multiNumber("versions")).toEqual([1.0, 1.1, 2.0]);
+    expect(frontMatter.multiNumber("missing")).toEqual([]);
+});
+test("multiBoolean メソッドで複数真偽値を取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        flags: [true, false, true],
+        permissions: [false, false],
+    });
+    expect(frontMatter.multiBoolean("flags")).toEqual([true, false, true]);
+    expect(frontMatter.multiBoolean("permissions")).toEqual([false, false]);
+    expect(frontMatter.multiBoolean("missing")).toEqual([]);
+});
+test("has メソッドでプロパティの存在を確認できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        title: "テスト",
+        count: 0,
+        flag: false,
+        nullable: null,
+    });
+    expect(frontMatter.has("title")).toBe(true);
+    expect(frontMatter.has("count")).toBe(true);
+    expect(frontMatter.has("flag")).toBe(true);
+    expect(frontMatter.has("nullable")).toBe(true);
+    expect(frontMatter.has("missing")).toBe(false);
+});
+test("keys ゲッターですべてのキーを取得できる", () => {
+    const frontMatter = new DocFrontMatterMdValue({
+        title: "テスト",
+        version: 1.0,
+        published: true,
+    });
+    const keys = frontMatter.keys;
+    expect(keys).toHaveLength(3);
+    expect(keys).toContain("title");
+    expect(keys).toContain("version");
+    expect(keys).toContain("published");
+});
+test("空のFrontMatterでも正常に動作する", () => {
+    const frontMatter = DocFrontMatterMdValue.empty();
+    expect(frontMatter.text("any")).toBeNull();
+    expect(frontMatter.number("any")).toBeNull();
+    expect(frontMatter.boolean("any")).toBeNull();
+    expect(frontMatter.relation("any")).toBeNull();
+    expect(frontMatter.multiRelation("any")).toEqual([]);
+    expect(frontMatter.multiText("any")).toEqual([]);
+    expect(frontMatter.multiNumber("any")).toEqual([]);
+    expect(frontMatter.multiBoolean("any")).toEqual([]);
+    expect(frontMatter.has("any")).toBe(false);
+    expect(frontMatter.keys).toEqual([]);
+});

package/build/values/doc-relation-field-value.d.ts

@@ -0,0 +1,57 @@
+import type { DocRelationField } from "../types";
+/**
+ * リレーションフィールド
+ */
+export declare class DocRelationFieldValue {
+    private readonly value;
+    constructor(value: DocRelationField);
+    /**
+     * フィールド名を取得
+     */
+    get fieldName(): string;
+    /**
+     * リレーション先のパスを取得
+     */
+    get relationPath(): string;
+    /**
+     * 配列型かどうかを取得
+     */
+    get isArray(): boolean;
+    /**
+     * 単一リレーションかどうかを判定
+     */
+    get isSingle(): boolean;
+    /**
+     * 複数リレーションかどうかを判定
+     */
+    get isMultiple(): boolean;
+    /**
+     * リレーション先のディレクトリ名を取得
+     */
+    get targetDirectoryName(): string;
+    /**
+     * 完全なリレーションパスを生成
+     */
+    getFullPath(basePath: string): string;
+    /**
+     * 等価性の判定
+     */
+    equals(other: DocRelationFieldValue): boolean;
+    /**
+     * データから生成
+     */
+    static from(data: unknown): DocRelationFieldValue;
+    /**
+     * プロパティから生成
+     */
+    static fromProps(props: {
+        fieldName: string;
+        filePath: string;
+        isArray: boolean;
+    }): DocRelationFieldValue;
+    /**
+     * JSON形式に変換
+     */
+    toJson(): DocRelationField;
+}
+//# sourceMappingURL=doc-relation-field-value.d.ts.map

package/build/values/doc-relation-field-value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-relation-field-value.d.ts","sourceRoot":"","sources":["../../lib/values/doc-relation-field-value.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAA;AAEhD;;GAEG;AACH,qBAAa,qBAAqB;IACpB,OAAO,CAAC,QAAQ,CAAC,KAAK;IAAlC,YAA6B,KAAK,EAAE,gBAAgB,EAGnD;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,QAAQ,YAEX;IAED;;OAEG;IACH,IAAI,UAAU,YAEb;IAED;;OAEG;IACH,IAAI,mBAAmB,WAGtB;IAED;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,CAKpC;IAED;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO,CAM5C;IAED;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,GAAG,qBAAqB,CAGhD;IAED;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,KAAK,EAAE;QACtB,SAAS,EAAE,MAAM,CAAA;QACjB,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,OAAO,CAAA;KACjB,GAAG,qBAAqB,CAExB;IAED;;OAEG;IACH,MAAM,IAAI,gBAAgB,CAEzB;CACF"}

package/build/values/doc-relation-field-value.js

@@ -0,0 +1,85 @@
+import { zDocRelationField } from "../models";
+/**
+ * リレーションフィールド
+ */
+export class DocRelationFieldValue {
+    value;
+    constructor(value) {
+        this.value = value;
+        zDocRelationField.parse(value);
+        Object.freeze(this);
+    }
+    /**
+     * フィールド名を取得
+     */
+    get fieldName() {
+        return this.value.fieldName;
+    }
+    /**
+     * リレーション先のパスを取得
+     */
+    get relationPath() {
+        return this.value.filePath;
+    }
+    /**
+     * 配列型かどうかを取得
+     */
+    get isArray() {
+        return this.value.isArray;
+    }
+    /**
+     * 単一リレーションかどうかを判定
+     */
+    get isSingle() {
+        return !this.value.isArray;
+    }
+    /**
+     * 複数リレーションかどうかを判定
+     */
+    get isMultiple() {
+        return this.value.isArray;
+    }
+    /**
+     * リレーション先のディレクトリ名を取得
+     */
+    get targetDirectoryName() {
+        const parts = this.value.filePath.split("/");
+        return parts[parts.length - 1] || "";
+    }
+    /**
+     * 完全なリレーションパスを生成
+     */
+    getFullPath(basePath) {
+        if (this.value.filePath.startsWith("/")) {
+            return this.value.filePath;
+        }
+        return `${basePath}/${this.value.filePath}`;
+    }
+    /**
+     * 等価性の判定
+     */
+    equals(other) {
+        return (this.fieldName === other.fieldName &&
+            this.relationPath === other.relationPath &&
+            this.isArray === other.isArray);
+    }
+    /**
+     * データから生成
+     */
+    static from(data) {
+        const validated = zDocRelationField.parse(data);
+        return new DocRelationFieldValue(validated);
+    }
+    /**
+     * プロパティから生成
+     */
+    static fromProps(props) {
+        return new DocRelationFieldValue(props);
+    }
+    /**
+     * JSON形式に変換
+     */
+    toJson() {
+        return { ...this.value };
+    }
+}

package/build/values/doc-relation-field-value.test.d.ts

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

package/build/values/doc-relation-field-value.test.d.ts.map

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