@interactive-inc/docs-client 1.1.1 → 2.0.0

package/build/file-system.js

@@ -1,8 +1,13 @@
 import * as fs from 'fs/promises';
 
 // lib/modules/path-system/doc-path-system.ts
-var DocPathSystem = class {
+var DocPathSystem = class _DocPathSystem {
   separator = "/";
+  constructor() {
+    if (new.target === _DocPathSystem) {
+      Object.freeze(this);
+    }
+  }
   /**
    * Join paths
    */
@@ -58,8 +63,8 @@ var DocPathSystem = class {
    * Calculate relative path
    */
   relative(from, to) {
-    const fromSegments = from.split(this.separator).filter(Boolean);
-    const toSegments = to.split(this.separator).filter(Boolean);
+    const fromSegments = from.split(this.separator).filter((s) => s !== "" && s !== ".");
+    const toSegments = to.split(this.separator).filter((s) => s !== "" && s !== ".");
     let commonLength = 0;
     for (let i = 0; i < Math.min(fromSegments.length, toSegments.length); i++) {
       if (fromSegments[i] === toSegments[i]) {
@@ -268,6 +273,7 @@ var DocFileSystemNodeRead = class {
   constructor(props) {
     this.basePath = props.basePath;
     this.pathSystem = props.pathSystem ?? new DocPathSystem();
+    Object.freeze(this);
   }
   /**
    * Read file content at the specified path
@@ -317,9 +323,7 @@ var DocFileSystemNodeRead = class {
       if (fileNames instanceof Error) {
         return fileNames;
       }
-      return fileNames.map(
-        (fileName) => this.pathSystem.join(relativePath, fileName)
-      );
+      return fileNames.map((fileName) => this.pathSystem.join(relativePath, fileName));
     } catch (error) {
       return error instanceof Error ? error : new Error(`Failed to read directory file paths at ${relativePath}`);
     }
@@ -429,6 +433,7 @@ var DocFileSystemNodeWrite = class {
     this.basePath = props.basePath;
     this.pathSystem = props.pathSystem ?? new DocPathSystem();
     this.reader = props.reader;
+    Object.freeze(this);
   }
   /**
    * Write content to file at the specified path (creates directory if needed)
@@ -498,9 +503,7 @@ var DocFileSystemNodeWrite = class {
       await fs.copyFile(sourceFullPath, destFullPath);
       return null;
     } catch (error) {
-      return error instanceof Error ? error : new Error(
-        `Failed to copy file from ${sourcePath} to ${destinationPath}`
-      );
+      return error instanceof Error ? error : new Error(`Failed to copy file from ${sourcePath} to ${destinationPath}`);
     }
   }
   /**
@@ -513,9 +516,7 @@ var DocFileSystemNodeWrite = class {
       await fs.rename(sourceFullPath, destFullPath);
       return null;
     } catch (error) {
-      return error instanceof Error ? error : new Error(
-        `Failed to move file from ${sourcePath} to ${destinationPath}`
-      );
+      return error instanceof Error ? error : new Error(`Failed to move file from ${sourcePath} to ${destinationPath}`);
     }
   }
 };

package/build/index.d.ts

@@ -1,6 +1,19 @@
-import { D as DocFileSystemInterface, a as DocPathSystem } from './doc-file-system.interface-C5vpYrOL.js';
+import { D as DocFileSystemInterface, a as DocPathSystem } from './doc-file-system.interface-CmQywbuP.js';
 import { z } from 'zod';
-import { zDocFileMd, zDocFileUnknown, zDocClientConfig, zDocFilePath, zDocFileIndexSchemaField, zDocSchemaFieldText, zDocSchemaFieldNumber, zDocSchemaFieldBoolean, zDocSchemaFieldRelation, zDocSchemaFieldSelectText, zDocSchemaFieldSelectNumber, zDocSchemaFieldMultiText, zDocSchemaFieldMultiNumber, zDocSchemaFieldMultiRelation, zDocSchemaFieldMultiSelectText, zDocSchemaFieldMultiSelectNumber, zDocFileIndex, zDocRelation, zDocRelationFile, zDocMetaFieldRelation, zDocMetaFieldMultiRelation, zDocMetaFieldText, zDocMetaFieldNumber, zDocMetaFieldBoolean, zDocMetaFieldMultiText, zDocMetaFieldMultiNumber, zDocRelationField, zDocMetaField, zDocMetaFieldSelectText, zDocMetaFieldSelectNumber, zDocMetaFieldMultiSelectText, zDocMetaFieldMultiSelectNumber, zDocMetaFieldTypeText, zDocMetaFieldTypeNumber, zDocMetaFieldTypeBoolean, zDocMetaFieldTypeSelectText, zDocMetaFieldTypeSelectNumber, zDocMetaFieldTypeRelation, zDocMetaFieldType } from './models.js';
+import { zDocFileMd, zDocFileUnknown, zDocClientConfig, zDocFilePath, zDocFileIndexSchemaField, zDocSchemaFieldText, zDocSchemaFieldNumber, zDocSchemaFieldBoolean, zDocSchemaFieldRelation, zDocSchemaFieldSelectText, zDocSchemaFieldSelectNumber, zDocSchemaFieldMultiText, zDocSchemaFieldMultiNumber, zDocSchemaFieldMultiRelation, zDocSchemaFieldMultiSelectText, zDocSchemaFieldMultiSelectNumber, zDocDirectoryMeta, zDocFileIndex, zDocRelation, zDocRelationFile, zDocMetaFieldRelation, zDocMetaFieldMultiRelation, zDocMetaFieldText, zDocMetaFieldNumber, zDocMetaFieldBoolean, zDocMetaFieldMultiText, zDocMetaFieldMultiNumber, zDocRelationField, zDocMetaField, zDocMetaFieldSelectText, zDocMetaFieldSelectNumber, zDocMetaFieldMultiSelectText, zDocMetaFieldMultiSelectNumber, zDocMetaFieldTypeText, zDocMetaFieldTypeNumber, zDocMetaFieldTypeBoolean, zDocMetaFieldTypeSelectText, zDocMetaFieldTypeSelectNumber, zDocMetaFieldTypeRelation, zDocMetaFieldType } from './models.js';
+
+type SafeMethod<F> = F extends (...args: infer A) => Promise<infer R> ? (...args: A) => Promise<R | Error> : F;
+/**
+ * All async methods return T | Error instead of throwing.
+ *
+ * Promise を返すメソッドのみ T | Error に変換される。AsyncGenerator を返すメソッド
+ * （filesGenerator など）は変換されないため、安全に列挙したい場合は配列を返す
+ * files()/mdFiles() を .safe 経由で使うこと
+ */
+type Safe<T> = {
+    [K in keyof T as K extends "safe" ? never : K]: SafeMethod<T[K]>;
+};
+declare function createSafeProxy<T extends object>(target: T): Safe<T>;
 
 /**
  * Single boolean type schema field
@@ -298,7 +311,6 @@ declare class DocFileIndexSchemaValue<T extends DocCustomSchema> {
     toJson(): DocFileIndexSchema<keyof T>;
     /**
      * Create empty schema entity
-     * biome-ignore lint/complexity/noBannedTypes: {} as DocCustomSchema
      */
     static empty(): DocFileIndexSchemaValue<{}>;
 }
@@ -357,19 +369,9 @@ declare class DocFileIndexMetaValue<T extends DocCustomSchema> {
      * Generate empty FrontMatter
      */
     static empty<T extends DocCustomSchema>(customSchema: T, config: DocClientConfig): DocFileIndexMetaValue<T>;
-    /**
-     * Extract icon
-     */
+    static emptySchema<T extends DocCustomSchema>(customSchema: T): DocFileIndexSchema<keyof T>;
     private static extractIcon;
-    /**
-     * Extract schema part
-     */
     private static extractSchema;
-    /**
-     * Normalize entire schema
-     */
-    private static normalizeSchema;
-    static emptySchema<T extends DocCustomSchema>(customSchema: T): DocFileIndexSchema<keyof T>;
 }
 
 /**
@@ -408,6 +410,11 @@ declare class DocFileIndexContentValue<T extends DocCustomSchema> {
      * Generate from Markdown text
      */
     static fromMarkdown<T extends DocCustomSchema>(markdown: string, customSchema: T, config: DocClientConfig): DocFileIndexContentValue<T>;
+    /**
+     * Generate from Markdown text with .meta.json
+     * FrontMatter is ignored, only body/title/description are extracted
+     */
+    static fromMarkdownWithDirectoryMeta<T extends DocCustomSchema>(markdown: string, customSchema: T, config: DocClientConfig, directoryMeta: DocDirectoryMeta): DocFileIndexContentValue<T>;
     /**
      * Update content
      */
@@ -424,6 +431,10 @@ declare class DocFileIndexContentValue<T extends DocCustomSchema> {
      * Generate default index.md content
      */
     static empty<T extends DocCustomSchema = DocCustomSchema>(directoryName: string, customSchema: T, config: DocClientConfig): DocFileIndexContentValue<T>;
+    /**
+     * Generate default index.md content with .meta.json
+     */
+    static emptyWithDirectoryMeta<T extends DocCustomSchema = DocCustomSchema>(directoryName: string, customSchema: T, config: DocClientConfig, directoryMeta: DocDirectoryMeta): DocFileIndexContentValue<T>;
     /**
      * Generate complete text combining FrontMatter and body
      */
@@ -488,14 +499,11 @@ declare class DocRelationFileValue {
      * Convert to JSON format
      */
     toJson(): DocRelationFile;
-    /**
-     * Extract file name from file path (without extension)
-     */
-    private static extractFileName;
     /**
      * Create from file path and title
      */
     static from(filePath: string, title: string | null): DocRelationFileValue;
+    private static extractFileName;
 }
 
 /**
@@ -542,41 +550,18 @@ declare class DocFileRelationReference {
     private readonly props;
     private readonly pathSystem;
     constructor(props: Props$8);
+    get safe(): Safe<this>;
     get fileSystem(): DocFileSystemInterface;
     get basePath(): string;
-    /**
-     * Relation path
-     */
     get path(): string;
-    /**
-     * Full path
-     */
     get fullPath(): string;
-    read(): Promise<DocRelationValue | Error | null>;
-    /**
-     * Read list of relation files
-     */
-    readFiles(): Promise<DocRelationFileValue[] | Error>;
-    /**
-     * Read single relation file
-     */
-    readFile(filePath: string): Promise<DocRelationFileValue | Error | null>;
-    /**
-     * Check if file exists
-     */
+    read(): Promise<DocRelationValue | null>;
+    readFiles(): Promise<DocRelationFileValue[]>;
+    readFile(filePath: string): Promise<DocRelationFileValue | null>;
     exists(slug: string): Promise<boolean>;
-    /**
-     * Get list of file names (without extension)
-     */
-    readSlugs(): Promise<string[] | Error>;
-    /**
-     * Get file count
-     */
-    count(): Promise<number | Error>;
-    /**
-     * Check if empty
-     */
-    isEmpty(): Promise<boolean | Error>;
+    readSlugs(): Promise<string[]>;
+    count(): Promise<number>;
+    isEmpty(): Promise<boolean>;
 }
 
 type Props$7<T extends DocCustomSchema> = {
@@ -594,62 +579,31 @@ declare class DocFileIndexReference<T extends DocCustomSchema> {
     private readonly pathSystem;
     private readonly customSchema;
     constructor(props: Props$7<T>);
+    get safe(): Safe<this>;
     get fileSystem(): DocFileSystemInterface;
     get basePath(): string;
     get filePath(): string;
     get fileFullPath(): string;
-    get durectoryPath(): string;
-    read(): Promise<DocFileIndexEntity<T> | Error>;
+    get directoryPath(): string;
+    read(): Promise<DocFileIndexEntity<T>>;
+    private readDirectoryMeta;
     readSchemaValue(): Promise<DocFileIndexSchema<RecordKey>>;
-    /**
-     * Read file content
-     */
-    readContent(): Promise<Error | string>;
+    readContent(): Promise<string>;
     /**
      * Create empty DocFileIndexEntity
      */
     empty(): DocFileIndexEntity<T>;
-    /**
-     * Write content to file
-     */
-    writeContent(content: string): Promise<Error | null>;
-    /**
-     * Write entity
-     */
-    write(entity: DocFileIndexEntity<T>): Promise<Error | null>;
-    /**
-     * Create new file with default content
-     */
-    writeDefault(): Promise<Error | null>;
-    /**
-     * Delete file
-     */
-    delete(): Promise<Error | null>;
-    /**
-     * Check if file exists
-     */
+    writeContent(content: string): Promise<void>;
+    write(entity: DocFileIndexEntity<T>): Promise<void>;
+    writeDefault(): Promise<void>;
+    delete(): Promise<void>;
     exists(): Promise<boolean>;
-    relations(): Promise<DocFileRelationReference[] | Error>;
-    readRelations(): Promise<DocRelationValue[] | Error>;
-    /**
-     * Get file size in bytes
-     */
-    size(): Promise<number | Error>;
-    /**
-     * Get last modified date
-     */
-    lastModified(): Promise<Date | Error>;
-    /**
-     * Get file creation date
-     */
-    createdAt(): Promise<Date | Error>;
-    /**
-     * Move file to archive and return new reference
-     */
+    relations(): Promise<DocFileRelationReference[]>;
+    readRelations(): Promise<DocRelationValue[]>;
+    size(): Promise<number>;
+    lastModified(): Promise<Date>;
+    createdAt(): Promise<Date>;
     archive(archiveDirectoryName?: string): Promise<DocFileIndexReference<T>>;
-    /**
-     * Restore file from archive and return new reference
-     */
     restore(archiveDirectoryName?: string): Promise<DocFileIndexReference<T>>;
 }
 
@@ -677,7 +631,6 @@ declare class DocFileMdMetaValue<T extends DocCustomSchema> {
     hasKey(key: keyof T): boolean;
     toJson(): SchemaToValueType<T>;
     toYaml(): string;
-    private validateValue;
     private getValueField;
     /**
      * Generate from Markdown text
@@ -831,68 +784,30 @@ declare class DocFileUnknownReference<T extends DocCustomSchema> {
     private readonly pathSystem;
     private readonly customSchema;
     constructor(props: Props$6<T>);
+    get safe(): Safe<this>;
     get fileSystem(): DocFileSystemInterface;
     get basePath(): string;
     get path(): string;
     get directoryPath(): string;
     get fileFullPath(): string;
     directory(): DocDirectoryReference<T>;
-    read(): Promise<Error | DocFileUnknownEntity>;
-    /**
-     * Read file content
-     */
-    readContent(): Promise<Error | string>;
+    read(): Promise<DocFileUnknownEntity>;
+    readContent(): Promise<string>;
     /**
      * Create empty DocFileUnknownEntity
      */
     empty(): DocFileUnknownEntity;
-    /**
-     * Write content to file
-     */
-    writeContent(content: string): Promise<Error | null>;
-    /**
-     * Write entity
-     */
-    write(entity: DocFileUnknownEntity): Promise<Error | null>;
-    /**
-     * Write raw content
-     */
-    writeRaw(content: string): Promise<Error | null>;
-    /**
-     * Delete file
-     */
-    delete(): Promise<Error | null>;
-    /**
-     * Check if file exists
-     */
+    writeContent(content: string): Promise<void>;
+    write(entity: DocFileUnknownEntity): Promise<void>;
+    writeRaw(content: string): Promise<void>;
+    delete(): Promise<void>;
     exists(): Promise<boolean>;
-    /**
-     * Copy file
-     */
-    copyTo(destinationPath: string): Promise<Error | null>;
-    /**
-     * Move file
-     */
-    moveTo(destinationPath: string): Promise<Error | null>;
-    /**
-     * Get file size in bytes
-     */
-    size(): Promise<number | Error>;
-    /**
-     * Get file last modified time
-     */
-    lastModified(): Promise<Date | Error>;
-    /**
-     * Get file creation time
-     */
-    createdAt(): Promise<Date | Error>;
-    /**
-     * Move file to archive and return new reference
-     */
+    copyTo(destinationPath: string): Promise<void>;
+    moveTo(destinationPath: string): Promise<void>;
+    size(): Promise<number>;
+    lastModified(): Promise<Date>;
+    createdAt(): Promise<Date>;
     archive(archiveDirectoryName?: string): Promise<DocFileUnknownReference<T>>;
-    /**
-     * Restore file from archive and return new reference
-     */
     restore(archiveDirectoryName?: string): Promise<DocFileUnknownReference<T>>;
 }
 
@@ -915,6 +830,7 @@ declare class DocDirectoryReference<T extends DocCustomSchema> {
     private readonly pathSystem;
     private readonly customSchema;
     constructor(props: Props$5<T>);
+    get safe(): Safe<this>;
     get fileSystem(): DocFileSystemInterface;
     get basePath(): string;
     get config(): DocClientConfig;
@@ -932,10 +848,10 @@ declare class DocDirectoryReference<T extends DocCustomSchema> {
     get indexFilePath(): string;
     get archiveDirectoryName(): string;
     get name(): string;
-    fileNames(): Promise<string[] | Error>;
-    archivedFileNames(): Promise<string[] | Error>;
+    fileNames(): Promise<string[]>;
+    archivedFileNames(): Promise<string[]>;
     filesGenerator(): AsyncGenerator<DocFileDirectoryReference<T>, void, unknown>;
-    mdFilesGenerator(): AsyncGenerator<DocFileMdReference<T> | Error, void, unknown>;
+    mdFilesGenerator(): AsyncGenerator<DocFileMdReference<T>, void, unknown>;
     files(): Promise<DocFileDirectoryReference<T>[]>;
     mdFiles(): Promise<DocFileMdReference<T>[]>;
     file<FileName extends string>(fileName: FileName): InferReference<FileName, T>;
@@ -943,30 +859,15 @@ declare class DocDirectoryReference<T extends DocCustomSchema> {
     readFiles(): Promise<DocFileDirectoryEntity<T>[]>;
     readMdFiles(): Promise<DocFileMdEntity<T>[]>;
     readUnknownFiles(): Promise<DocFileUnknownEntity[]>;
-    /**
-     * Get list of subdirectory names
-     */
     directoryNames(): Promise<string[]>;
-    /**
-     * Get subdirectory references
-     */
     directories(): Promise<DocDirectoryReference<T>[]>;
-    /**
-     * Get single subdirectory reference
-     */
     directory(directoryName: string): DocDirectoryReference<T>;
     directory<S extends DocCustomSchema>(directoryName: string, customSchema: S): DocDirectoryReference<S>;
     indexFile(): DocFileIndexReference<T>;
-    readIndexFile(): Promise<DocFileIndexEntity<T> | Error>;
-    writeFile(entity: DocFileIndexEntity<T> | DocFileMdEntity<T> | DocFileUnknownEntity): Promise<Error | null>;
+    readIndexFile(): Promise<DocFileIndexEntity<T>>;
+    writeFile(entity: DocFileIndexEntity<T> | DocFileMdEntity<T> | DocFileUnknownEntity): Promise<void>;
     exists(): Promise<boolean>;
-    /**
-     * Create new Markdown file
-     */
     createMdFile(fileName?: string): Promise<DocFileMdReference<T>>;
-    /**
-     * Generate unique filename
-     */
     private uniqueFileName;
 }
 
@@ -985,6 +886,7 @@ declare class DocFileMdReference<T extends DocCustomSchema> {
     private readonly pathSystem;
     private readonly customSchema;
     constructor(props: Props$4<T>);
+    get safe(): Safe<this>;
     get fileSystem(): DocFileSystemInterface;
     get basePath(): string;
     get path(): string;
@@ -994,77 +896,36 @@ declare class DocFileMdReference<T extends DocCustomSchema> {
     get name(): string;
     get nameWithExtension(): string;
     exists(): Promise<boolean>;
-    read(): Promise<DocFileMdEntity<T> | Error>;
-    /**
-     * Read file content
-     */
-    readText(): Promise<Error | string>;
+    read(): Promise<DocFileMdEntity<T>>;
+    readText(): Promise<string>;
     /**
      * Create empty DocFileMdEntity
      */
     empty(): DocFileMdEntity<T>;
-    /**
-     * Write entity
-     */
-    write(entity: DocFileMdEntity<T>): Promise<Error | null>;
-    writeText(text: string): Promise<Error | null>;
-    /**
-     * Create new file with default content
-     */
-    writeDefault(): Promise<Error | null>;
-    /**
-     * Delete file
-     */
-    delete(): Promise<Error | null>;
-    /**
-     * Copy file
-     */
-    copyTo(destinationPath: string): Promise<Error | null>;
-    /**
-     * Move file
-     */
-    moveTo(destinationPath: string): Promise<Error | null>;
-    /**
-     * Move file to archive and return new reference
-     */
+    write(entity: DocFileMdEntity<T>): Promise<void>;
+    writeText(text: string): Promise<void>;
+    writeDefault(): Promise<void>;
+    delete(): Promise<void>;
+    copyTo(destinationPath: string): Promise<void>;
+    moveTo(destinationPath: string): Promise<void>;
     archive(archiveDirectoryName?: string): Promise<DocFileMdReference<T>>;
-    /**
-     * Restore file from archive and return new reference
-     */
     restore(archiveDirectoryName?: string): Promise<DocFileMdReference<T>>;
-    /**
-     * Get file size in bytes
-     */
-    size(): Promise<number | Error>;
-    /**
-     * Get file last modified time
-     */
-    lastModified(): Promise<Date | Error>;
-    /**
-     * Get file creation time
-     */
-    createdAt(): Promise<Date | Error>;
+    size(): Promise<number>;
+    lastModified(): Promise<Date>;
+    createdAt(): Promise<Date>;
     directory(): DocDirectoryReference<T>;
+    relation(key: RelationKeys<T>): Promise<DocFileMdReference<DocCustomSchema> | null>;
+    relation<U extends DocCustomSchema>(key: RelationKeys<T>, targetSchema: U): Promise<DocFileMdReference<U> | null>;
     /**
-     * Get relation based on schema
-     */
-    relation<U extends DocCustomSchema = DocCustomSchema>(key: RelationKeys<T>, targetSchema?: U): Promise<DocFileMdReference<U> | Error | null>;
-    /**
-     * Get index.md in the same directory
+     * スキーマで定義された relation の path を解決する。
+     * ".." 始まりの相対パスはファイルのディレクトリ基準で正規化する
      */
+    private resolveRelationDirectory;
     directoryIndex(): Promise<DocFileIndexReference<T> | null>;
-    /**
-     * Get multiple relations based on schema
-     */
-    relations<U extends DocCustomSchema = DocCustomSchema>(key: MultiRelationKeys<T>, customSchema?: U): Promise<DocFileMdReference<U>[]>;
-    /**
-     * File: Markdown > FrontMatter
-     */
-    readFrontMatter(): Promise<DocFileMdMetaValue<T> | Error>;
-    /**
-     * File: Markdown > FrontMatter
-     */
-    updateFrontMatter<K extends keyof T>(key: K, value: BaseFieldValueType<ExtractFieldType<T[K]>>): Promise<this | Error>;
+    relations(key: MultiRelationKeys<T>): Promise<DocFileMdReference<DocCustomSchema>[]>;
+    relations<U extends DocCustomSchema>(key: MultiRelationKeys<T>, customSchema: U): Promise<DocFileMdReference<U>[]>;
+    readFrontMatter(): Promise<DocFileMdMetaValue<T>>;
+    updateFrontMatter<K extends keyof T>(key: K, value: BaseFieldValueType<ExtractFieldType<T[K]>>): Promise<this>;
 }
 
 /**
@@ -1367,6 +1228,10 @@ type RecordKey = PropertyKey;
  * DocClient configuration
  */
 type DocClientConfig = z.infer<typeof zDocClientConfig>;
+/**
+ * Directory meta (.meta.json)
+ */
+type DocDirectoryMeta = z.infer<typeof zDocDirectoryMeta>;
 /**
  * Type definitions for DocFileMdMetaValue
  */
@@ -1502,10 +1367,18 @@ declare class DocFileTreeSystem {
      * Create file node
      */
     private createFileNode;
+    /**
+     * Read title from a file
+     */
+    private readFileTitle;
     /**
      * Create directory node
      */
     private createDirectoryNode;
+    /**
+     * Read title and icon from directory index file
+     */
+    private readDirectoryIndexInfo;
     /**
      * Create index file reference
      */
@@ -1518,10 +1391,6 @@ declare class DocFileTreeSystem {
      * Build directory tree recursively (directories only)
      */
     buildDirectoryTree(directoryPath?: string): Promise<DocTreeDirectoryNodeValue[] | Error>;
-    /**
-     * Create directory node for directory tree
-     */
-    private createDirectoryNodeForTree;
 }
 
 /**
@@ -1573,9 +1442,6 @@ type Props = {
     pathSystem?: DocPathSystem;
     markdownSystem?: DocMarkdownSystem;
     fileTreeSystem?: DocFileTreeSystem;
-    /**
-     * Configuration
-     */
     config?: DocClientConfig;
 };
 declare class DocClient {
@@ -1585,6 +1451,7 @@ declare class DocClient {
     readonly fileTreeSystem: DocFileTreeSystem;
     readonly config: DocClientConfig;
     constructor(props: Props);
+    get safe(): Safe<this>;
     basePath(): string;
     file<Path extends string>(relativePath: Path): InferReference<Path, DocCustomSchema>;
     file<Path extends string, T extends DocCustomSchema>(relativePath: Path, customSchema: T): InferReference<Path, T>;
@@ -1714,6 +1581,7 @@ declare class DocCustomSchemaFieldValue<T extends DocCustomSchemaField> {
     readonly value: T;
     constructor(value: T);
     validate(value: unknown): string | number | boolean | string[] | number[] | null;
+    private fieldType;
 }
 
 /**
@@ -1903,4 +1771,4 @@ declare class DocRelationFieldValue {
     }): DocRelationFieldValue;
 }
 
-export { type BaseFieldValueType, type DetectFileType, DocClient, type DocClientConfig, type DocCustomSchema, type DocCustomSchemaField, type DocCustomSchemaFieldBoolean, type DocCustomSchemaFieldMultiNumber, type DocCustomSchemaFieldMultiRelation, type DocCustomSchemaFieldMultiSelectNumber, type DocCustomSchemaFieldMultiSelectText, type DocCustomSchemaFieldMultiText, type DocCustomSchemaFieldNumber, type DocCustomSchemaFieldRelation, type DocCustomSchemaFieldSelectNumber, type DocCustomSchemaFieldSelectText, type DocCustomSchemaFieldText, DocCustomSchemaFieldValue, type DocDirectory, type DocDirectoryFile, DocDirectoryPathValue, DocDirectoryReference, type DocFieldTypeLiteral, type DocFile, type DocFileAny, type DocFileEntity, type DocFileIndex, type DocFileIndexAny, type DocFileIndexContent, DocFileIndexContentValue, DocFileIndexEntity, type DocFileIndexMeta, DocFileIndexMetaValue, DocFileIndexReference, type DocFileIndexSchema, type DocFileIndexSchemaField, DocFileIndexSchemaValue, type DocFileMd, type DocFileMdAny, type DocFileMdContent, DocFileMdContentValue, DocFileMdEntity, type DocFileMdMeta, type DocFileMdMetaAny, DocFileMdMetaValue, DocFileMdReference, type DocFilePath, DocFilePathValue, DocFileRelationReference, DocFileTreeSystem, type DocFileUnknown, DocFileUnknownEntity, DocFileUnknownReference, DocMarkdownSystem, type DocMetaField, type DocMetaFieldBoolean, type DocMetaFieldMultiNumber, type DocMetaFieldMultiRelation, type DocMetaFieldMultiSelectNumber, type DocMetaFieldMultiSelectText, type DocMetaFieldMultiText, type DocMetaFieldNumber, type DocMetaFieldRelation, type DocMetaFieldSelectNumber, type DocMetaFieldSelectText, type DocMetaFieldText, type DocMetaFieldType, type DocMetaFieldTypeBoolean, type DocMetaFieldTypeNumber, type DocMetaFieldTypeRelation, type DocMetaFieldTypeSelectNumber, type DocMetaFieldTypeSelectText, type DocMetaFieldTypeText, DocPathSystem, DocPathSystemMock, type DocRelation, type DocRelationField, DocRelationFieldValue, type DocRelationFile, DocRelationFileValue, DocRelationValue, type DocSchemaFieldBoolean, type DocSchemaFieldMultiNumber, type DocSchemaFieldMultiRelation, type DocSchemaFieldMultiSelectNumber, type DocSchemaFieldMultiSelectText, type DocSchemaFieldMultiText, type DocSchemaFieldNumber, type DocSchemaFieldRelation, type DocSchemaFieldSelectNumber, type DocSchemaFieldSelectText, type DocSchemaFieldText, type DocSchemaRelationFieldUnion, type DocTreeDirectoryNode, DocTreeDirectoryNodeValue, type DocTreeFileNode, DocTreeFileNodeValue, type DocTreeNode, type DocTreeNodeValue, type Equals, type ExtractFieldType, type ExtractRequired, type FieldValueType, type GetIndexFieldType, type GetValueType, type InferDocFileMd, type InferReference, type MultiRelationKeys, type OptionalKeys, type RecordKey, type RelationKeys, type RequiredKeys, type SchemaToValueType, type UpdateFunction, assertType, defaultTestConfig, defineSchema, docCustomSchemaField, expectType };
+export { type BaseFieldValueType, type DetectFileType, DocClient, type DocClientConfig, type DocCustomSchema, type DocCustomSchemaField, type DocCustomSchemaFieldBoolean, type DocCustomSchemaFieldMultiNumber, type DocCustomSchemaFieldMultiRelation, type DocCustomSchemaFieldMultiSelectNumber, type DocCustomSchemaFieldMultiSelectText, type DocCustomSchemaFieldMultiText, type DocCustomSchemaFieldNumber, type DocCustomSchemaFieldRelation, type DocCustomSchemaFieldSelectNumber, type DocCustomSchemaFieldSelectText, type DocCustomSchemaFieldText, DocCustomSchemaFieldValue, type DocDirectory, type DocDirectoryFile, type DocDirectoryMeta, DocDirectoryPathValue, DocDirectoryReference, type DocFieldTypeLiteral, type DocFile, type DocFileAny, type DocFileEntity, type DocFileIndex, type DocFileIndexAny, type DocFileIndexContent, DocFileIndexContentValue, DocFileIndexEntity, type DocFileIndexMeta, DocFileIndexMetaValue, DocFileIndexReference, type DocFileIndexSchema, type DocFileIndexSchemaField, DocFileIndexSchemaValue, type DocFileMd, type DocFileMdAny, type DocFileMdContent, DocFileMdContentValue, DocFileMdEntity, type DocFileMdMeta, type DocFileMdMetaAny, DocFileMdMetaValue, DocFileMdReference, type DocFilePath, DocFilePathValue, DocFileRelationReference, DocFileTreeSystem, type DocFileUnknown, DocFileUnknownEntity, DocFileUnknownReference, DocMarkdownSystem, type DocMetaField, type DocMetaFieldBoolean, type DocMetaFieldMultiNumber, type DocMetaFieldMultiRelation, type DocMetaFieldMultiSelectNumber, type DocMetaFieldMultiSelectText, type DocMetaFieldMultiText, type DocMetaFieldNumber, type DocMetaFieldRelation, type DocMetaFieldSelectNumber, type DocMetaFieldSelectText, type DocMetaFieldText, type DocMetaFieldType, type DocMetaFieldTypeBoolean, type DocMetaFieldTypeNumber, type DocMetaFieldTypeRelation, type DocMetaFieldTypeSelectNumber, type DocMetaFieldTypeSelectText, type DocMetaFieldTypeText, DocPathSystem, DocPathSystemMock, type DocRelation, type DocRelationField, DocRelationFieldValue, type DocRelationFile, DocRelationFileValue, DocRelationValue, type DocSchemaFieldBoolean, type DocSchemaFieldMultiNumber, type DocSchemaFieldMultiRelation, type DocSchemaFieldMultiSelectNumber, type DocSchemaFieldMultiSelectText, type DocSchemaFieldMultiText, type DocSchemaFieldNumber, type DocSchemaFieldRelation, type DocSchemaFieldSelectNumber, type DocSchemaFieldSelectText, type DocSchemaFieldText, type DocSchemaRelationFieldUnion, type DocTreeDirectoryNode, DocTreeDirectoryNodeValue, type DocTreeFileNode, DocTreeFileNodeValue, type DocTreeNode, type DocTreeNodeValue, type Equals, type ExtractFieldType, type ExtractRequired, type FieldValueType, type GetIndexFieldType, type GetValueType, type InferDocFileMd, type InferReference, type MultiRelationKeys, type OptionalKeys, type RecordKey, type RelationKeys, type RequiredKeys, type Safe, type SchemaToValueType, type UpdateFunction, assertType, createSafeProxy, defaultTestConfig, defineSchema, docCustomSchemaField, expectType };