@interactive-inc/docs-client 0.0.3 → 0.0.5

package/build/values/doc-schema-field-boolean-single-value.js

@@ -0,0 +1,39 @@
+/**
+ * 単一ブール型スキーマフィールド
+ */
+export class DocSchemaFieldBooleanSingleValue {
+    key;
+    value;
+    constructor(key, value) {
+        this.key = key;
+        this.value = value;
+        Object.freeze(this);
+    }
+    get type() {
+        return this.value.type;
+    }
+    get required() {
+        return this.value.required;
+    }
+    get title() {
+        return this.value.title ?? "";
+    }
+    get description() {
+        return this.value.description ?? "";
+    }
+    get default() {
+        return this.value.default;
+    }
+    isArray = false;
+    isSingle = true;
+    isBoolean = true;
+    toJson() {
+        return { ...this.value };
+    }
+    /**
+     * 値の型を検証する
+     */
+    validate(value) {
+        return typeof value === "boolean";
+    }
+}

package/build/values/doc-schema-field-boolean-single-value.test.d.ts

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

package/build/values/doc-schema-field-boolean-single-value.test.d.ts.map

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

package/build/values/doc-schema-field-boolean-single-value.test.js

@@ -0,0 +1,73 @@
+import { expect, test } from "bun:test";
+import { DocSchemaFieldBooleanSingleValue } from "./doc-schema-field-boolean-single-value";
+test("単一ブール型フィールドの基本プロパティを取得できる", () => {
+    const field = new DocSchemaFieldBooleanSingleValue("isPublished", {
+        type: "boolean",
+        required: true,
+        title: "公開状態",
+        description: "記事が公開されているかどうか",
+        default: false,
+    });
+    expect(field.key).toBe("isPublished");
+    expect(field.type).toBe("boolean");
+    expect(field.required).toBe(true);
+    expect(field.title).toBe("公開状態");
+    expect(field.description).toBe("記事が公開されているかどうか");
+    expect(field.default).toBe(false);
+});
+test("配列判定メソッドが正しく動作する", () => {
+    const field = new DocSchemaFieldBooleanSingleValue("active", {
+        type: "boolean",
+        required: false,
+        title: null,
+        description: null,
+        default: null,
+    });
+    expect(field.isArray).toBe(false);
+    expect(field.isSingle).toBe(true);
+    expect(field.isBoolean).toBe(true);
+});
+test("オプショナルなプロパティがundefinedでも動作する", () => {
+    const field = new DocSchemaFieldBooleanSingleValue("flag", {
+        type: "boolean",
+        required: true,
+        title: null,
+        description: null,
+        default: null,
+    });
+    expect(field.title).toBe("");
+    expect(field.description).toBe("");
+    expect(field.default).toBe(null);
+});
+test("値の検証メソッドが正しく動作する", () => {
+    const field = new DocSchemaFieldBooleanSingleValue("enabled", {
+        type: "boolean",
+        required: true,
+        title: null,
+        description: null,
+        default: null,
+    });
+    expect(field.validate(true)).toBe(true);
+    expect(field.validate(false)).toBe(true);
+    expect(field.validate("true")).toBe(false);
+    expect(field.validate(1)).toBe(false);
+    expect(field.validate(null)).toBe(false);
+    expect(field.validate(undefined)).toBe(false);
+});
+test("JSON形式に変換できる", () => {
+    const field = new DocSchemaFieldBooleanSingleValue("featured", {
+        type: "boolean",
+        required: false,
+        title: "注目記事",
+        description: null,
+        default: false,
+    });
+    const json = field.toJson();
+    expect(json).toEqual({
+        type: "boolean",
+        required: false,
+        title: "注目記事",
+        description: null,
+        default: false,
+    });
+});

package/build/values/doc-schema-field-factory.d.ts

@@ -0,0 +1,37 @@
+import type { DocSchemaField } from "../types";
+import type { DocSchemaFieldValue } from "./doc-schema-field-value";
+/**
+ * スキーマフィールドファクトリ
+ */
+export declare class DocSchemaFieldFactory {
+    constructor();
+    /**
+     * スキーマエントリから適切な型のフィールドを生成
+     */
+    fromSchemaEntry(key: string, field: DocSchemaField): DocSchemaFieldValue;
+    /**
+     * 未検証のデータから正規化して生成
+     */
+    fromUnknown(key: string, data: unknown): DocSchemaFieldValue;
+    /**
+     * フィールド定義を正規化
+     */
+    private normalizeField;
+    /**
+     * デフォルトのテキストフィールドを作成
+     */
+    private createDefaultTextField;
+    /**
+     * 型名を正規化
+     */
+    private normalizeType;
+    /**
+     * オブジェクトからプロパティを安全に取得
+     */
+    private getFieldProperty;
+    /**
+     * 型固有のデフォルト値を取得（イミュータブル）
+     */
+    private getTypeSpecificDefaults;
+}
+//# sourceMappingURL=doc-schema-field-factory.d.ts.map

package/build/values/doc-schema-field-factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-schema-field-factory.d.ts","sourceRoot":"","sources":["../../lib/values/doc-schema-field-factory.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAe9C,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAEnE;;GAEG;AACH,qBAAa,qBAAqB;IAChC,cAEC;IAED;;OAEG;IACH,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,cAAc,GAAG,mBAAmB,CAkDvE;IAED;;OAEG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO,GAAG,mBAAmB,CAI3D;IAED;;OAEG;IACH,OAAO,CAAC,cAAc;IAgCtB;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAU9B;;OAEG;IACH,OAAO,CAAC,aAAa;IAUrB;;OAEG;IACH,OAAO,CAAC,gBAAgB;IAOxB;;OAEG;IACH,OAAO,CAAC,uBAAuB;CAkBhC"}

package/build/values/doc-schema-field-factory.js

@@ -0,0 +1,151 @@
+import { zDocSchemaField } from "../models";
+import { DocSchemaFieldBooleanMultipleValue } from "./doc-schema-field-boolean-multiple-value";
+import { DocSchemaFieldBooleanSingleValue } from "./doc-schema-field-boolean-single-value";
+import { DocSchemaFieldNumberMultipleValue } from "./doc-schema-field-number-multiple-value";
+import { DocSchemaFieldNumberSingleValue } from "./doc-schema-field-number-single-value";
+import { DocSchemaFieldRelationMultipleValue } from "./doc-schema-field-relation-multiple-value";
+import { DocSchemaFieldRelationSingleValue } from "./doc-schema-field-relation-single-value";
+import { DocSchemaFieldSelectNumberMultipleValue } from "./doc-schema-field-select-number-multiple-value";
+import { DocSchemaFieldSelectNumberSingleValue } from "./doc-schema-field-select-number-single-value";
+import { DocSchemaFieldSelectTextMultipleValue } from "./doc-schema-field-select-text-multiple-value";
+import { DocSchemaFieldSelectTextSingleValue } from "./doc-schema-field-select-text-single-value";
+import { DocSchemaFieldTextMultipleValue } from "./doc-schema-field-text-multiple-value";
+import { DocSchemaFieldTextSingleValue } from "./doc-schema-field-text-single-value";
+import { DocSchemaFieldTypeValue } from "./doc-schema-field-type-value";
+/**
+ * スキーマフィールドファクトリ
+ */
+export class DocSchemaFieldFactory {
+    constructor() {
+        Object.freeze(this);
+    }
+    /**
+     * スキーマエントリから適切な型のフィールドを生成
+     */
+    fromSchemaEntry(key, field) {
+        if (field.type === "text") {
+            return new DocSchemaFieldTextSingleValue(key, field);
+        }
+        if (field.type === "multi-text") {
+            return new DocSchemaFieldTextMultipleValue(key, field);
+        }
+        if (field.type === "number") {
+            return new DocSchemaFieldNumberSingleValue(key, field);
+        }
+        if (field.type === "multi-number") {
+            return new DocSchemaFieldNumberMultipleValue(key, field);
+        }
+        if (field.type === "boolean") {
+            return new DocSchemaFieldBooleanSingleValue(key, field);
+        }
+        if (field.type === "multi-boolean") {
+            return new DocSchemaFieldBooleanMultipleValue(key, field);
+        }
+        if (field.type === "select-text") {
+            return new DocSchemaFieldSelectTextSingleValue(key, field);
+        }
+        if (field.type === "select-number") {
+            return new DocSchemaFieldSelectNumberSingleValue(key, field);
+        }
+        if (field.type === "multi-select-text") {
+            return new DocSchemaFieldSelectTextMultipleValue(key, field);
+        }
+        if (field.type === "multi-select-number") {
+            return new DocSchemaFieldSelectNumberMultipleValue(key, field);
+        }
+        if (field.type === "relation") {
+            return new DocSchemaFieldRelationSingleValue(key, field);
+        }
+        if (field.type === "multi-relation") {
+            return new DocSchemaFieldRelationMultipleValue(key, field);
+        }
+        throw new Error("Unknown field type");
+    }
+    /**
+     * 未検証のデータから正規化して生成
+     */
+    fromUnknown(key, data) {
+        const normalized = this.normalizeField(data);
+        const validated = zDocSchemaField.parse(normalized);
+        return this.fromSchemaEntry(key, validated);
+    }
+    /**
+     * フィールド定義を正規化
+     */
+    normalizeField(field) {
+        if (!field || typeof field !== "object") {
+            // オブジェクトでない場合はデフォルトのテキストフィールドとして扱う
+            return this.createDefaultTextField();
+        }
+        const fieldType = this.getFieldProperty(field, "type");
+        const fieldRequired = this.getFieldProperty(field, "required");
+        const fieldTitle = this.getFieldProperty(field, "title");
+        const fieldDescription = this.getFieldProperty(field, "description");
+        const fieldDefault = this.getFieldProperty(field, "default");
+        // 型の正規化
+        const normalizedType = this.normalizeType(fieldType);
+        const typeValue = DocSchemaFieldTypeValue.from(normalizedType);
+        // 正規化されたフィールドを構築
+        const baseField = {
+            type: normalizedType,
+            required: fieldRequired ?? false,
+            title: fieldTitle,
+            description: fieldDescription,
+            default: fieldDefault,
+        };
+        // 型固有のデフォルト値を追加
+        return {
+            ...baseField,
+            ...this.getTypeSpecificDefaults(field, typeValue),
+        };
+    }
+    /**
+     * デフォルトのテキストフィールドを作成
+     */
+    createDefaultTextField() {
+        return {
+            type: "text",
+            required: false,
+            title: "",
+            description: "",
+            default: "",
+        };
+    }
+    /**
+     * 型名を正規化
+     */
+    normalizeType(type) {
+        if (typeof type !== "string")
+            return "text";
+        // 旧型名から新型名への変換
+        if (type === "string")
+            return "text";
+        if (type === "multi-string")
+            return "multi-text";
+        return type;
+    }
+    /**
+     * オブジェクトからプロパティを安全に取得
+     */
+    getFieldProperty(obj, key) {
+        if (Object.hasOwn(obj, key)) {
+            return Object.getOwnPropertyDescriptor(obj, key)?.value;
+        }
+        return null;
+    }
+    /**
+     * 型固有のデフォルト値を取得（イミュータブル）
+     */
+    getTypeSpecificDefaults(field, fieldType) {
+        const defaults = {};
+        // リレーション型の場合、pathが必要
+        if (fieldType.isRelation) {
+            defaults.path = this.getFieldProperty(field, "path") ?? "";
+        }
+        // 選択型の場合、optionsが必要
+        if (fieldType.isSelect) {
+            defaults.options = this.getFieldProperty(field, "options") ?? [];
+        }
+        return defaults;
+    }
+}

package/build/values/doc-schema-field-factory.test.d.ts

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

package/build/values/doc-schema-field-factory.test.d.ts.map

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

package/build/values/doc-schema-field-factory.test.js

@@ -0,0 +1,215 @@
+import { expect, test } from "bun:test";
+import { DocSchemaFieldBooleanSingleValue } from "./doc-schema-field-boolean-single-value";
+import { DocSchemaFieldFactory } from "./doc-schema-field-factory";
+import { DocSchemaFieldNumberSingleValue } from "./doc-schema-field-number-single-value";
+import { DocSchemaFieldRelationMultipleValue } from "./doc-schema-field-relation-multiple-value";
+import { DocSchemaFieldRelationSingleValue } from "./doc-schema-field-relation-single-value";
+import { DocSchemaFieldSelectTextSingleValue } from "./doc-schema-field-select-text-single-value";
+import { DocSchemaFieldTextMultipleValue } from "./doc-schema-field-text-multiple-value";
+import { DocSchemaFieldTextSingleValue } from "./doc-schema-field-text-single-value";
+test("テキスト型フィールドを生成できる", () => {
+    const factory = new DocSchemaFieldFactory();
+    const field = factory.fromSchemaEntry("title", {
+        type: "text",
+        required: true,
+        title: "タイトル",
+        description: null,
+        default: null,
+    });
+    expect(field).toBeInstanceOf(DocSchemaFieldTextSingleValue);
+    expect(field.key).toBe("title");
+    expect(field.type).toBe("text");
+});
+test("数値型フィールドを生成できる", () => {
+    const factory = new DocSchemaFieldFactory();
+    const field = factory.fromSchemaEntry("price", {
+        type: "number",
+        required: false,
+        title: null,
+        description: null,
+        default: 1000,
+    });
+    expect(field).toBeInstanceOf(DocSchemaFieldNumberSingleValue);
+    expect(field.type).toBe("number");
+    expect(field.default).toBe(1000);
+});
+test("ブール型フィールドを生成できる", () => {
+    const factory = new DocSchemaFieldFactory();
+    const field = factory.fromSchemaEntry("published", {
+        type: "boolean",
+        required: true,
+        title: null,
+        description: null,
+        default: false,
+    });
+    expect(field).toBeInstanceOf(DocSchemaFieldBooleanSingleValue);
+    expect(field.type).toBe("boolean");
+});
+test("リレーション型フィールドを生成できる", () => {
+    const factory = new DocSchemaFieldFactory();
+    const field = factory.fromSchemaEntry("author", {
+        type: "relation",
+        required: true,
+        title: null,
+        description: null,
+        default: null,
+        path: "users/authors",
+    });
+    expect(field).toBeInstanceOf(DocSchemaFieldRelationSingleValue);
+    expect(field.type).toBe("relation");
+    expect(field.path).toBe("users/authors");
+});
+test("選択型フィールドを生成できる", () => {
+    const factory = new DocSchemaFieldFactory();
+    const field = factory.fromSchemaEntry("status", {
+        type: "select-text",
+        required: false,
+        title: null,
+        description: null,
+        default: null,
+        options: ["draft", "published"],
+    });
+    expect(field).toBeInstanceOf(DocSchemaFieldSelectTextSingleValue);
+    expect(field.options).toEqual([
+        "draft",
+        "published",
+    ]);
+});
+test("複数型フィールドを生成できる", () => {
+    const factory = new DocSchemaFieldFactory();
+    const field = factory.fromSchemaEntry("tags", {
+        type: "multi-text",
+        required: false,
+        title: null,
+        description: null,
+        default: ["tech", "news"],
+    });
+    expect(field).toBeInstanceOf(DocSchemaFieldTextMultipleValue);
+    expect(field.isArray).toBe(true);
+    expect(field.default).toEqual(["tech", "news"]);
+});
+test("複数リレーション型フィールドを生成できる", () => {
+    const factory = new DocSchemaFieldFactory();
+    const field = factory.fromSchemaEntry("categories", {
+        type: "multi-relation",
+        required: false,
+        title: null,
+        description: null,
+        default: null,
+        path: "metadata/categories",
+    });
+    expect(field).toBeInstanceOf(DocSchemaFieldRelationMultipleValue);
+    expect(field.path).toBe("metadata/categories");
+});
+test("不明な型でエラーが発生する", () => {
+    const factory = new DocSchemaFieldFactory();
+    expect(() => {
+        factory.fromSchemaEntry("unknown", {
+            type: "invalid-type",
+            required: false,
+            title: null,
+            description: null,
+            default: null,
+        });
+    }).toThrow();
+});
+test("fromUnknownメソッドで未検証データから生成できる", () => {
+    const factory = new DocSchemaFieldFactory();
+    // 正しいデータ
+    const field1 = factory.fromUnknown("field1", {
+        type: "text",
+        required: true,
+        title: null,
+        description: null,
+        default: null,
+    });
+    expect(field1).toBeInstanceOf(DocSchemaFieldTextSingleValue);
+    // 型が古い形式
+    const field2 = factory.fromUnknown("field2", {
+        type: "string",
+        required: false,
+        title: null,
+        description: null,
+        default: null,
+    });
+    expect(field2).toBeInstanceOf(DocSchemaFieldTextSingleValue);
+    expect(field2.type).toBe("text");
+    // オブジェクトでない場合
+    const field3 = factory.fromUnknown("field3", null);
+    expect(field3).toBeInstanceOf(DocSchemaFieldTextSingleValue);
+    expect(field3.required).toBe(false);
+    // 必須プロパティが欠けている場合
+    const field4 = factory.fromUnknown("field4", {});
+    expect(field4).toBeInstanceOf(DocSchemaFieldTextSingleValue);
+    expect(field4.type).toBe("text");
+    expect(field4.required).toBe(false);
+});
+test("型固有のデフォルト値が設定される", () => {
+    const factory = new DocSchemaFieldFactory();
+    // リレーション型でpathが設定されている場合
+    const relation = factory.fromUnknown("rel", {
+        type: "relation",
+        required: true,
+        title: null,
+        description: null,
+        default: null,
+        path: "some/valid/path",
+    });
+    expect(relation.path).toBe("some/valid/path");
+    // 選択型でoptionsが無い場合
+    const select = factory.fromUnknown("sel", {
+        type: "select-text",
+        required: false,
+        title: null,
+        description: null,
+        default: null,
+    });
+    expect(select.options).toEqual([]);
+});
+test("リレーション型でpathが空の場合はエラーが発生する", () => {
+    const factory = new DocSchemaFieldFactory();
+    // pathが空文字列の場合
+    expect(() => {
+        factory.fromUnknown("rel", {
+            type: "relation",
+            required: true,
+            title: null,
+            description: null,
+            default: null,
+            path: "",
+        });
+    }).toThrow();
+    // pathが未定義の場合
+    expect(() => {
+        factory.fromUnknown("rel", {
+            type: "relation",
+            required: true,
+            title: null,
+            description: null,
+            default: null,
+        });
+    }).toThrow();
+});
+test("multi-string型をmulti-textに正規化する", () => {
+    const factory = new DocSchemaFieldFactory();
+    const field = factory.fromUnknown("field", {
+        type: "multi-string",
+        required: false,
+        title: null,
+        description: null,
+        default: null,
+    });
+    expect(field).toBeInstanceOf(DocSchemaFieldTextMultipleValue);
+    expect(field.type).toBe("multi-text");
+});
+test("undefinedプロパティがnullに変換される", () => {
+    const factory = new DocSchemaFieldFactory();
+    // titleプロパティが存在しない場合
+    const field = factory.fromUnknown("field", {
+        type: "text",
+        required: true,
+        // title: undefined (プロパティが存在しない)
+    });
+    expect(field.title).toBe("");
+    expect(field.description).toBe("");
+});

package/build/values/doc-schema-field-number-multiple-value.d.ts

@@ -0,0 +1,23 @@
+import type { DocFieldMultiNumber, DocSchemaField } from "../types";
+/**
+ * 数値複数型スキーマフィールド
+ */
+export declare class DocSchemaFieldNumberMultipleValue {
+    readonly key: string;
+    readonly value: DocFieldMultiNumber;
+    constructor(key: string, value: DocFieldMultiNumber);
+    get type(): "multi-number";
+    get required(): boolean;
+    get title(): string;
+    get description(): string;
+    get default(): number[] | null;
+    readonly isArray: boolean;
+    readonly isSingle: boolean;
+    readonly isNumber: boolean;
+    /**
+     * 値を検証する
+     */
+    validate(value: unknown): boolean;
+    toJson(): DocSchemaField;
+}
+//# sourceMappingURL=doc-schema-field-number-multiple-value.d.ts.map

package/build/values/doc-schema-field-number-multiple-value.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"doc-schema-field-number-multiple-value.d.ts","sourceRoot":"","sources":["../../lib/values/doc-schema-field-number-multiple-value.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEnE;;GAEG;AACH,qBAAa,iCAAiC;IAE1C,QAAQ,CAAC,GAAG,EAAE,MAAM;IACpB,QAAQ,CAAC,KAAK,EAAE,mBAAmB;IAFrC,YACW,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,mBAAmB,EAOpC;IAED,IAAI,IAAI,mBAEP;IAED,IAAI,QAAQ,YAEX;IAED,IAAI,KAAK,WAER;IAED,IAAI,WAAW,WAEd;IAED,IAAI,OAAO,oBAEV;IAED,QAAQ,CAAC,OAAO,UAAO;IAEvB,QAAQ,CAAC,QAAQ,UAAQ;IAEzB,QAAQ,CAAC,QAAQ,UAAO;IAExB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,OAAO,CAEhC;IAED,MAAM,IAAI,cAAc,CAEvB;CACF"}

package/build/values/doc-schema-field-number-multiple-value.js

@@ -0,0 +1,43 @@
+/**
+ * 数値複数型スキーマフィールド
+ */
+export class DocSchemaFieldNumberMultipleValue {
+    key;
+    value;
+    constructor(key, value) {
+        this.key = key;
+        this.value = value;
+        Object.freeze(this);
+        Object.freeze(this.value);
+        if (this.value.default) {
+            Object.freeze(this.value.default);
+        }
+    }
+    get type() {
+        return this.value.type;
+    }
+    get required() {
+        return this.value.required;
+    }
+    get title() {
+        return this.value.title ?? "";
+    }
+    get description() {
+        return this.value.description ?? "";
+    }
+    get default() {
+        return this.value.default;
+    }
+    isArray = true;
+    isSingle = false;
+    isNumber = true;
+    /**
+     * 値を検証する
+     */
+    validate(value) {
+        return Array.isArray(value) && value.every((v) => typeof v === "number");
+    }
+    toJson() {
+        return { ...this.value };
+    }
+}

package/build/values/doc-schema-field-number-multiple-value.test.d.ts

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

package/build/values/doc-schema-field-number-multiple-value.test.d.ts.map

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