@interactive-inc/docs-client 0.0.10 → 0.0.11

package/build/models.js

@@ -6,76 +6,69 @@ var zDocFilePath = z.object({
   fullPath: z.string(),
   nameWithExtension: z.string()
 });
-var zDocSchemaFieldTypeText = z.literal("text");
-var zDocSchemaFieldTypeNumber = z.literal("number");
-var zDocSchemaFieldTypeBoolean = z.literal("boolean");
-var zDocSchemaFieldTypeMultiText = z.literal("multi-text");
-var zDocSchemaFieldTypeMultiNumber = z.literal("multi-number");
-var zDocSchemaFieldTypeMultiBoolean = z.literal("multi-boolean");
-var zDocSchemaFieldTypeRelation = z.literal("relation");
-var zDocSchemaFieldTypeMultiRelation = z.literal("multi-relation");
-var zDocSchemaFieldTypeSelectText = z.literal("select-text");
-var zDocSchemaFieldTypeSelectNumber = z.literal("select-number");
-var zDocSchemaFieldTypeMultiSelectText = z.literal("multi-select-text");
-var zDocSchemaFieldTypeMultiSelectNumber = z.literal("multi-select-number");
-var zDocSchemaFieldType = z.union([
-  zDocSchemaFieldTypeText,
-  zDocSchemaFieldTypeNumber,
-  zDocSchemaFieldTypeBoolean,
-  zDocSchemaFieldTypeMultiText,
-  zDocSchemaFieldTypeMultiNumber,
-  zDocSchemaFieldTypeMultiBoolean,
-  zDocSchemaFieldTypeRelation,
-  zDocSchemaFieldTypeMultiRelation,
-  zDocSchemaFieldTypeSelectText,
-  zDocSchemaFieldTypeSelectNumber,
-  zDocSchemaFieldTypeMultiSelectText,
-  zDocSchemaFieldTypeMultiSelectNumber
+var zDocMetaFieldTypeText = z.literal("text");
+var zDocMetaFieldTypeNumber = z.literal("number");
+var zDocMetaFieldTypeBoolean = z.literal("boolean");
+var zDocMetaFieldTypeSelectText = z.literal("select-text");
+var zDocMetaFieldTypeSelectNumber = z.literal("select-number");
+var zDocMetaFieldTypeRelation = z.literal("relation");
+var zDocMetaFieldTypeMultiText = z.literal("multi-text");
+var zDocMetaFieldTypeMultiNumber = z.literal("multi-number");
+var zDocMetaFieldTypeMultiRelation = z.literal("multi-relation");
+var zDocMetaFieldTypeMultiSelectText = z.literal("multi-select-text");
+var zDocMetaFieldTypeMultiSelectNumber = z.literal(
+  "multi-select-number"
+);
+var zDocMetaFieldType = z.union([
+  zDocMetaFieldTypeText,
+  zDocMetaFieldTypeNumber,
+  zDocMetaFieldTypeBoolean,
+  zDocMetaFieldTypeMultiText,
+  zDocMetaFieldTypeMultiNumber,
+  zDocMetaFieldTypeRelation,
+  zDocMetaFieldTypeMultiRelation,
+  zDocMetaFieldTypeSelectText,
+  zDocMetaFieldTypeSelectNumber,
+  zDocMetaFieldTypeMultiSelectText,
+  zDocMetaFieldTypeMultiSelectNumber
 ]);
 var zDocSchemaFieldText = z.object({
-  type: zDocSchemaFieldTypeText,
+  type: zDocMetaFieldTypeText,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
   default: z.string().nullable()
 });
 var zDocSchemaFieldNumber = z.object({
-  type: zDocSchemaFieldTypeNumber,
+  type: zDocMetaFieldTypeNumber,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
   default: z.number().nullable()
 });
 var zDocSchemaFieldBoolean = z.object({
-  type: zDocSchemaFieldTypeBoolean,
+  type: zDocMetaFieldTypeBoolean,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
   default: z.boolean().nullable()
 });
 var zDocSchemaFieldMultiText = z.object({
-  type: zDocSchemaFieldTypeMultiText,
+  type: zDocMetaFieldTypeMultiText,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
   default: z.array(z.string()).nullable()
 });
 var zDocSchemaFieldMultiNumber = z.object({
-  type: zDocSchemaFieldTypeMultiNumber,
+  type: zDocMetaFieldTypeMultiNumber,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
   default: z.array(z.number()).nullable()
 });
-var zDocSchemaFieldMultiBoolean = z.object({
-  type: zDocSchemaFieldTypeMultiBoolean,
-  required: z.boolean(),
-  title: z.string().nullable(),
-  description: z.string().nullable(),
-  default: z.array(z.boolean()).nullable()
-});
 var zDocSchemaFieldRelation = z.object({
-  type: zDocSchemaFieldTypeRelation,
+  type: zDocMetaFieldTypeRelation,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
@@ -83,7 +76,7 @@ var zDocSchemaFieldRelation = z.object({
   default: z.string().nullable()
 });
 var zDocSchemaFieldMultiRelation = z.object({
-  type: zDocSchemaFieldTypeMultiRelation,
+  type: zDocMetaFieldTypeMultiRelation,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
@@ -91,7 +84,7 @@ var zDocSchemaFieldMultiRelation = z.object({
   default: z.array(z.string()).nullable()
 });
 var zDocSchemaFieldSelectText = z.object({
-  type: zDocSchemaFieldTypeSelectText,
+  type: zDocMetaFieldTypeSelectText,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
@@ -99,7 +92,7 @@ var zDocSchemaFieldSelectText = z.object({
   default: z.string().nullable()
 });
 var zDocSchemaFieldSelectNumber = z.object({
-  type: zDocSchemaFieldTypeSelectNumber,
+  type: zDocMetaFieldTypeSelectNumber,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
@@ -107,7 +100,7 @@ var zDocSchemaFieldSelectNumber = z.object({
   default: z.number().nullable()
 });
 var zDocSchemaFieldMultiSelectText = z.object({
-  type: zDocSchemaFieldTypeMultiSelectText,
+  type: zDocMetaFieldTypeMultiSelectText,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
@@ -115,20 +108,19 @@ var zDocSchemaFieldMultiSelectText = z.object({
   default: z.array(z.string()).nullable()
 });
 var zDocSchemaFieldMultiSelectNumber = z.object({
-  type: zDocSchemaFieldTypeMultiSelectNumber,
+  type: zDocMetaFieldTypeMultiSelectNumber,
   required: z.boolean(),
   title: z.string().nullable(),
   description: z.string().nullable(),
   options: z.array(z.number()),
   default: z.array(z.number()).nullable()
 });
-var zDocSchemaField = z.union([
+var zDocFileIndexSchemaField = z.union([
   zDocSchemaFieldText,
   zDocSchemaFieldNumber,
   zDocSchemaFieldBoolean,
   zDocSchemaFieldMultiText,
   zDocSchemaFieldMultiNumber,
-  zDocSchemaFieldMultiBoolean,
   zDocSchemaFieldRelation,
   zDocSchemaFieldMultiRelation,
   zDocSchemaFieldSelectText,
@@ -136,29 +128,99 @@ var zDocSchemaField = z.union([
   zDocSchemaFieldMultiSelectText,
   zDocSchemaFieldMultiSelectNumber
 ]);
-var zDocFileMdFrontMatter = z.record(
+var zDocMetaFieldText = z.string().nullable();
+var zDocMetaFieldBoolean = z.boolean().nullable();
+var zDocMetaFieldNumber = z.number().nullable();
+var zDocMetaFieldSelectText = z.string().nullable();
+var zDocMetaFieldSelectNumber = z.number().nullable();
+var zDocMetaFieldRelation = z.string().nullable();
+var zDocMetaFieldMultiText = z.string().array();
+var zDocMetaFieldMultiNumber = z.number().array();
+var zDocMetaFieldMultiBoolean = z.boolean().array();
+var zDocMetaFieldMultiSelectText = z.string().array();
+var zDocMetaFieldMultiSelectNumber = z.number().array();
+var zDocMetaFieldMultiRelation = z.string().array();
+var zDocMetaField = z.union([
+  zDocMetaFieldText,
+  zDocMetaFieldBoolean,
+  zDocMetaFieldNumber,
+  zDocMetaFieldSelectText,
+  zDocMetaFieldSelectNumber,
+  zDocMetaFieldRelation,
+  zDocMetaFieldMultiText,
+  zDocMetaFieldMultiNumber,
+  zDocMetaFieldMultiBoolean,
+  zDocMetaFieldMultiSelectText,
+  zDocMetaFieldMultiSelectNumber,
+  zDocMetaFieldMultiRelation
+]);
+var zDocFileMdMeta = z.record(z.string(), zDocMetaField);
+var zDocFileIndexSchema = z.record(
   z.string(),
-  z.union([
-    z.string(),
-    z.boolean(),
-    z.number(),
-    z.array(z.string()),
-    z.array(z.number()),
-    z.array(z.boolean()),
-    z.record(z.string(), z.unknown()),
-    z.null()
-  ])
+  zDocFileIndexSchemaField
 );
-var zDocSchema = z.record(z.string(), zDocSchemaField);
-var zDocSchemaFieldMinimal = z.object({
-  type: zDocSchemaFieldType,
+var zDocCustomSchemaFieldText = z.object({
+  type: zDocMetaFieldTypeText,
   required: z.boolean()
 });
-var zDocSchemaMinimal = z.record(z.string(), zDocSchemaFieldMinimal);
-var zDocFileIndexFrontMatter = z.object({
-  type: z.literal("index-frontmatter"),
-  icon: z.string(),
-  schema: zDocSchema
+var zDocCustomSchemaFieldNumber = z.object({
+  type: zDocMetaFieldTypeNumber,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldBoolean = z.object({
+  type: zDocMetaFieldTypeBoolean,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldRelation = z.object({
+  type: zDocMetaFieldTypeRelation,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldSelectText = z.object({
+  type: zDocMetaFieldTypeSelectText,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldSelectNumber = z.object({
+  type: zDocMetaFieldTypeSelectNumber,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldMultiText = z.object({
+  type: zDocMetaFieldTypeMultiText,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldMultiNumber = z.object({
+  type: zDocMetaFieldTypeMultiNumber,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldMultiRelation = z.object({
+  type: zDocMetaFieldTypeMultiRelation,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldMultiSelectText = z.object({
+  type: zDocMetaFieldTypeMultiSelectText,
+  required: z.boolean()
+});
+var zDocCustomSchemaFieldMultiSelectNumber = z.object({
+  type: zDocMetaFieldTypeMultiSelectNumber,
+  required: z.boolean()
+});
+var zDocCustomSchemaField = z.union([
+  zDocCustomSchemaFieldText,
+  zDocCustomSchemaFieldNumber,
+  zDocCustomSchemaFieldBoolean,
+  zDocCustomSchemaFieldRelation,
+  zDocCustomSchemaFieldSelectText,
+  zDocCustomSchemaFieldSelectNumber,
+  zDocCustomSchemaFieldMultiText,
+  zDocCustomSchemaFieldMultiNumber,
+  zDocCustomSchemaFieldMultiRelation,
+  zDocCustomSchemaFieldMultiSelectText,
+  zDocCustomSchemaFieldMultiSelectNumber
+]);
+var zDocCustomSchema = z.record(z.string(), zDocCustomSchemaField);
+var zDocFileIndexMeta = z.object({
+  type: z.literal("index-meta"),
+  icon: z.string().nullable(),
+  schema: zDocFileIndexSchema
 });
 var zDocRelationField = z.object({
   fieldName: z.string(),
@@ -175,24 +237,24 @@ var zDocRelation = z.object({
   path: z.string(),
   files: z.array(zDocRelationFile)
 });
-var zDocFileContentMd = z.object({
+var zDocFileMdContent = z.object({
   type: z.literal("markdown-content"),
   body: z.string(),
   title: z.string(),
   description: z.string(),
-  frontMatter: zDocFileMdFrontMatter
+  meta: zDocFileMdMeta
 });
-var zDocFileContentIndex = z.object({
+var zDocFileIndexContent = z.object({
   type: z.literal("markdown-index"),
   body: z.string(),
   title: z.string(),
   description: z.string(),
-  frontMatter: zDocFileIndexFrontMatter
+  meta: zDocFileIndexMeta
 });
 var zDocFileIndex = z.object({
   type: z.literal("index"),
   path: zDocFilePath,
-  content: zDocFileContentIndex,
+  content: zDocFileIndexContent,
   isArchived: z.boolean()
 });
 var zDocFileUnknown = z.object({
@@ -205,7 +267,7 @@ var zDocFileUnknown = z.object({
 var zDocFileMd = z.object({
   type: z.literal("markdown"),
   path: zDocFilePath,
-  content: zDocFileContentMd,
+  content: zDocFileMdContent,
   isArchived: z.boolean()
 });
 var zDocFile = z.union([zDocFileIndex, zDocFileMd, zDocFileUnknown]);
@@ -227,24 +289,76 @@ var zDocTreeDirectoryNode = z.lazy(() => {
   });
 });
 var zDocTreeNode = z.union([zDocTreeFileNode, zDocTreeDirectoryNode]);
+var zDocClientConfig = z.object({
+  defaultIndexIcon: z.string().optional(),
+  indexFileName: z.string().optional(),
+  archiveDirectoryName: z.string().optional(),
+  defaultDirectoryName: z.string().optional(),
+  indexMetaIncludes: z.array(z.string()).optional(),
+  directoryExcludes: z.array(z.string()).optional()
+}).transform((data) => ({
+  defaultIndexIcon: data.defaultIndexIcon ?? "\u{1F4C3}",
+  indexFileName: data.indexFileName ?? "index.md",
+  archiveDirectoryName: data.archiveDirectoryName ?? "_",
+  defaultDirectoryName: data.defaultDirectoryName ?? "Directory",
+  indexMetaIncludes: data.indexMetaIncludes ?? [],
+  directoryExcludes: data.directoryExcludes ?? [".vitepress"]
+}));
 export {
+  zDocClientConfig,
+  zDocCustomSchema,
+  zDocCustomSchemaField,
+  zDocCustomSchemaFieldBoolean,
+  zDocCustomSchemaFieldMultiNumber,
+  zDocCustomSchemaFieldMultiRelation,
+  zDocCustomSchemaFieldMultiSelectNumber,
+  zDocCustomSchemaFieldMultiSelectText,
+  zDocCustomSchemaFieldMultiText,
+  zDocCustomSchemaFieldNumber,
+  zDocCustomSchemaFieldRelation,
+  zDocCustomSchemaFieldSelectNumber,
+  zDocCustomSchemaFieldSelectText,
+  zDocCustomSchemaFieldText,
   zDocFile,
-  zDocFileContentIndex,
-  zDocFileContentMd,
   zDocFileIndex,
-  zDocFileIndexFrontMatter,
+  zDocFileIndexContent,
+  zDocFileIndexMeta,
+  zDocFileIndexSchema,
+  zDocFileIndexSchemaField,
   zDocFileMd,
-  zDocFileMdFrontMatter,
+  zDocFileMdContent,
+  zDocFileMdMeta,
   zDocFilePath,
   zDocFileUnknown,
+  zDocMetaField,
+  zDocMetaFieldBoolean,
+  zDocMetaFieldMultiBoolean,
+  zDocMetaFieldMultiNumber,
+  zDocMetaFieldMultiRelation,
+  zDocMetaFieldMultiSelectNumber,
+  zDocMetaFieldMultiSelectText,
+  zDocMetaFieldMultiText,
+  zDocMetaFieldNumber,
+  zDocMetaFieldRelation,
+  zDocMetaFieldSelectNumber,
+  zDocMetaFieldSelectText,
+  zDocMetaFieldText,
+  zDocMetaFieldType,
+  zDocMetaFieldTypeBoolean,
+  zDocMetaFieldTypeMultiNumber,
+  zDocMetaFieldTypeMultiRelation,
+  zDocMetaFieldTypeMultiSelectNumber,
+  zDocMetaFieldTypeMultiSelectText,
+  zDocMetaFieldTypeMultiText,
+  zDocMetaFieldTypeNumber,
+  zDocMetaFieldTypeRelation,
+  zDocMetaFieldTypeSelectNumber,
+  zDocMetaFieldTypeSelectText,
+  zDocMetaFieldTypeText,
   zDocRelation,
   zDocRelationField,
   zDocRelationFile,
-  zDocSchema,
-  zDocSchemaField,
   zDocSchemaFieldBoolean,
-  zDocSchemaFieldMinimal,
-  zDocSchemaFieldMultiBoolean,
   zDocSchemaFieldMultiNumber,
   zDocSchemaFieldMultiRelation,
   zDocSchemaFieldMultiSelectNumber,
@@ -255,8 +369,6 @@ export {
   zDocSchemaFieldSelectNumber,
   zDocSchemaFieldSelectText,
   zDocSchemaFieldText,
-  zDocSchemaFieldType,
-  zDocSchemaMinimal,
   zDocTreeDirectoryNode,
   zDocTreeFileNode,
   zDocTreeNode

package/debug/debug.ts

@@ -0,0 +1,40 @@
+import { DocClient } from "@/doc-client"
+import { DocFileSystem } from "@/doc-file-system"
+
+const client = new DocClient({
+  fileSystem: new DocFileSystem({ basePath: "../../docs" }),
+})
+
+const pagesRef = client.directory("docs-studio/pages", {
+  features: {
+    type: "multi-relation",
+    required: true,
+  },
+})
+
+const mdFileRef = await pagesRef.mdFile("document-editor")
+
+const mdFile = await mdFileRef.read()
+
+if (mdFile instanceof Error) {
+  throw mdFile
+}
+
+mdFile.withContent(
+  mdFile.content.withMetaProperty("features", [
+    "edit-document-content",
+    "delete-document",
+    "foo",
+  ]),
+)
+
+const relations = await mdFileRef.relations("features", {
+  "is-done": {
+    required: true,
+    type: "boolean",
+  },
+})
+
+const file = await relations[0].read()
+
+console.log("relations", file)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interactive-inc/docs-client",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "type": "module",
   "scripts": {
     "check": "tsgo --noEmit",

package/PRODUCT.md

@@ -1,108 +0,0 @@
-# docs-client
-
-ドキュメント管理システムのクライアントライブラリ。Markdownファイルを構造化された形式で管理し、フロントマターによるメタデータ管理、スキーマベースのバリデーション、ファイル間のリレーション機能を提供するゆ🥹
-
-## 主要機能
-
-### ドキュメント管理
-
-- Markdownファイルの読み書き
-- フロントマター（YAML形式）の解析と生成
-- ファイルのアーカイブと復元
-- 階層的なディレクトリ構造の管理
-
-### スキーマシステム
-
-- index.mdファイルでのスキーマ定義
-- Zodを使用した型安全なスキーマバリデーション
-- デフォルト値の自動適用
-- 動的なスキーマ生成（Zodスキーマ未定義時）
-
-### リレーション機能
-
-- ファイル間の参照関係を定義
-- 単一リレーション（relation）と複数リレーション（multi-relation）
-- スキーマベースの型安全な参照
-
-### ファイルツリー
-
-- ディレクトリ構造の再帰的探索
-- ファイルツリーとディレクトリツリーの生成
-- アーカイブディレクトリの特別扱い
-
-## アーキテクチャ
-
-### エンティティ（entities/）
-
-- **DocFileMdEntity** - Markdownファイルの表現
-- **DocDirectoryEntity** - ディレクトリの表現
-- **DocTreeFileNode/DocTreeDirectoryNode** - ツリー構造のノード
-
-### 値オブジェクト（values/）
-
-- **DocFileContentMdValue** - Markdownコンテンツ（フロントマター + 本文）
-- **DocFrontMatterIndexValue** - index.mdのフロントマター
-- **DocFrontMatterMdValue** - 通常のMarkdownファイルのフロントマター
-- **DocSchemaValue** - スキーマ定義と検証機能
-- **DocSchemaFieldValue** - スキーマフィールドの定義
-- **DocSchemaBuilder** - 動的スキーマ生成
-
-### リファレンス（references/）
-
-- **DocFileIndexReference** - index.mdファイルの参照
-- **DocFileMdReference** - Markdownファイルの参照
-- **DocDirectoryReference** - ディレクトリの参照
-
-### システム
-
-- **DocFileTreeSystem** - ファイルツリーの構築
-- **DocClient** - クライアントAPI
-- **DocEngine** - ドキュメント処理エンジンのクライアント側統合
-
-## 使用例
-
-```typescript
-// クライアントの初期化
-const client = new DocClient(cwd)
-
-// Markdownファイルの読み込み
-const fileRef = client.mdFile("products/example.md")
-const entity = await fileRef.read()
-
-// スキーマの取得と検証
-const indexRef = client.indexFile("products")
-const indexEntity = await indexRef.read()
-const schema = indexEntity.content.frontMatter.schema()
-
-// リレーションの取得
-const categoryRef = await fileRef.relation("category")
-
-// ファイルツリーの構築
-const fileTree = await client.fileTree("products")
-```
-
-## 特徴
-
-### 型安全性
-
-- TypeScriptのジェネリクスを活用
-- Zodスキーマによる実行時検証
-- 型推論による開発体験の向上
-
-### 不変性
-
-- すべての値オブジェクトは不変
-- Object.freeze()による状態の固定
-- Fluent APIによる操作
-
-### 拡張性
-
-- 依存性注入（DI）パターン
-- 明確な責任分離
-- カスタムスキーマフィールドの追加が容易
-
-## 依存関係
-
-- **@packages/server** - サーバー側のドキュメント処理エンジン
-- **zod** - スキーマ定義とバリデーション
-- **TypeScript** - 型安全性の保証