@interactive-inc/docs-client 1.0.12 → 1.0.13

package/build/index.d.ts

@@ -142,7 +142,7 @@ declare class DocFileSystem {
 /**
  * Meta
  */
-declare class DocFileMdMetaValue<T extends DocCustomSchema> {
+declare class DocFileMdMetaValue<T extends DocCustomSchemaGenerics> {
     readonly value: SchemaToValueType<T>;
     readonly customSchema: T;
     constructor(value: SchemaToValueType<T>, customSchema: T);
@@ -169,17 +169,17 @@ declare class DocFileMdMetaValue<T extends DocCustomSchema> {
     /**
      * Generate from Markdown text
      */
-    static fromYamlText<T extends DocCustomSchema>(yamlText: string, customSchema: T): DocFileMdMetaValue<T>;
-    static empty<T extends DocCustomSchema>(customSchema: T): DocFileMdMetaValue<T>;
+    static fromYamlText<T extends DocCustomSchemaGenerics>(yamlText: string, customSchema: T): DocFileMdMetaValue<T>;
+    static empty<T extends DocCustomSchemaGenerics>(customSchema: T): DocFileMdMetaValue<T>;
 }
 
 /**
  * File: Markdown > Content
  */
-declare class DocFileMdContentValue<T extends DocCustomSchema> {
-    readonly value: DocFileMdContent<T>;
+declare class DocFileMdContentValue<T extends DocCustomSchemaGenerics> {
+    readonly value: DocFileMdContentGenerics<T>;
     private readonly customSchema;
-    constructor(value: DocFileMdContent<T>, customSchema: T);
+    constructor(value: DocFileMdContentGenerics<T>, customSchema: T);
     /**
      * Content body (does not include frontMatter)
      */
@@ -211,7 +211,7 @@ declare class DocFileMdContentValue<T extends DocCustomSchema> {
     /**
      * Update FrontMatter
      */
-    withMeta<U extends DocCustomSchema>(meta: DocFileMdMetaValue<U>): DocFileMdContentValue<U>;
+    withMeta<U extends DocCustomSchemaGenerics>(meta: DocFileMdMetaValue<U>): DocFileMdContentValue<U>;
     /**
      * Update specific property of FrontMatter
      */
@@ -219,7 +219,7 @@ declare class DocFileMdContentValue<T extends DocCustomSchema> {
     /**
      * Generate from Markdown text
      */
-    static fromMarkdown<T extends DocCustomSchema>(markdown: string, customSchema: T): DocFileMdContentValue<T>;
+    static fromMarkdown<T extends DocCustomSchemaGenerics>(markdown: string, customSchema: T): DocFileMdContentValue<T>;
     /**
      * Generate complete Markdown text
      */
@@ -231,20 +231,20 @@ declare class DocFileMdContentValue<T extends DocCustomSchema> {
     /**
      * Generate empty content
      */
-    static empty<T extends DocCustomSchema = DocCustomSchema>(title: string, customSchema: T): DocFileMdContentValue<T>;
+    static empty<T extends DocCustomSchemaGenerics = DocCustomSchemaGenerics>(title: string, customSchema: T): DocFileMdContentValue<T>;
     /**
      * Output in JSON format
      */
-    toJson(): DocFileMdContent<T>;
+    toJson(): DocFileMdContentGenerics<T>;
 }
 
 /**
  * Markdown file entity
  */
-declare class DocFileMdEntity<T extends DocCustomSchema> {
-    readonly value: DocFileMd<T>;
+declare class DocFileMdEntity<T extends DocCustomSchemaGenerics> {
+    readonly value: DocFileMdGenerics<T>;
     private readonly customSchema;
-    constructor(value: DocFileMd<T>, customSchema: T);
+    constructor(value: DocFileMdGenerics<T>, customSchema: T);
     /**
      * Content
      */
@@ -270,7 +270,7 @@ declare class DocFileMdEntity<T extends DocCustomSchema> {
     toJson(): z.infer<typeof zDocFileMd>;
 }
 
-type Props$8<T extends DocCustomSchema> = {
+type Props$8<T extends DocCustomSchemaGenerics> = {
     path: string;
     fileSystem: DocFileSystem;
     pathSystem: DocPathSystem;
@@ -280,7 +280,7 @@ type Props$8<T extends DocCustomSchema> = {
 /**
  * File reference
  */
-declare class DocFileMdReference<T extends DocCustomSchema> {
+declare class DocFileMdReference<T extends DocCustomSchemaGenerics> {
     private readonly props;
     private readonly pathSystem;
     private readonly customSchema;
@@ -348,7 +348,7 @@ declare class DocFileMdReference<T extends DocCustomSchema> {
     /**
      * Get relation based on schema
      */
-    relation<U extends DocCustomSchema = DocCustomSchema>(key: RelationKeys<T>, targetSchema?: U): Promise<DocFileMdReference<U> | Error | null>;
+    relation<U extends DocCustomSchemaGenerics = DocCustomSchemaGenerics>(key: RelationKeys<T>, targetSchema?: U): Promise<DocFileMdReference<U> | Error | null>;
     /**
      * Get index.md in the same directory
      */
@@ -356,7 +356,7 @@ declare class DocFileMdReference<T extends DocCustomSchema> {
     /**
      * Get multiple relations based on schema
      */
-    relations<U extends DocCustomSchema = DocCustomSchema>(key: MultiRelationKeys<T>, customSchema?: U): Promise<DocFileMdReference<U>[]>;
+    relations<U extends DocCustomSchemaGenerics = DocCustomSchemaGenerics>(key: MultiRelationKeys<T>, customSchema?: U): Promise<DocFileMdReference<U>[]>;
     /**
      * File: Markdown > FrontMatter
      */
@@ -411,8 +411,8 @@ declare class DocFileUnknownReference {
     get directoryPath(): string;
     get fileFullPath(): string;
     get durectoryPath(): string;
-    directory<T extends DocCustomSchema>(customSchema: T): DocDirectoryReference<T>;
-    directory(): DocDirectoryReference<DocCustomSchema>;
+    directory<T extends DocCustomSchemaGenerics>(customSchema: T): DocDirectoryReference<T>;
+    directory(): DocDirectoryReference<DocCustomSchemaGenerics>;
     read(): Promise<Error | DocFileUnknownEntity>;
     /**
      * Read file content
@@ -591,7 +591,7 @@ type DocFileIndexSchemaField = z.infer<typeof zDocFileIndexSchemaField>;
 /**
  * Schema definition type
  */
-type DocFileIndexSchema<T extends RecordKey> = Record<T, DocFileIndexSchemaField>;
+type DocFileIndexSchemaGenerics<T extends RecordKey> = Record<T, DocFileIndexSchemaField>;
 /**
  * Schema field to override
  * ex: { xxx: { type: "text", required: true } }
@@ -604,7 +604,7 @@ type DocFieldTypeLiteral = "text" | "number" | "boolean" | "relation" | "multi-t
 /**
  * Minimal schema definition type
  */
-type DocCustomSchema<T extends RecordKey = RecordKey> = Record<T, DocCustomSchemaField>;
+type DocCustomSchemaGenerics<T extends RecordKey = RecordKey> = Record<T, DocCustomSchemaField>;
 /**
  * Union type for relation fields
  */
@@ -637,11 +637,11 @@ type DocTreeNode = DocTreeFileNode | DocTreeDirectoryNode;
 /**
  * Index file type
  */
-type DocFileIndex<T extends DocCustomSchema = DocCustomSchema> = {
+type DocFileIndexGenerics<T extends DocCustomSchemaGenerics = DocCustomSchemaGenerics> = {
     type: "index";
     path: DocFilePath;
     isArchived: boolean;
-    content: DocFileIndexContent<T>;
+    content: DocFileIndexContentGenerics<T>;
 };
 /**
  * Type to check if two types are equal
@@ -650,23 +650,23 @@ type Equals<T, U> = (<G>() => G extends T ? 1 : 2) extends <G>() => G extends U
 /**
  * Extract relation field keys from schema
  */
-type RelationKeys<T extends DocCustomSchema> = {
+type RelationKeys<T extends DocCustomSchemaGenerics> = {
     [K in keyof T]: T[K]["type"] extends "relation" ? K : never;
 }[keyof T];
 /**
  * Extract multi-relation field keys from schema
  */
-type MultiRelationKeys<T extends DocCustomSchema> = {
+type MultiRelationKeys<T extends DocCustomSchemaGenerics> = {
     [K in keyof T]: T[K]["type"] extends "multi-relation" ? K : never;
 }[keyof T];
 /**
  * Markdown file type (excluding index.md)
  */
-type DocFileMd<T extends DocCustomSchema> = {
+type DocFileMdGenerics<T extends DocCustomSchemaGenerics> = {
     type: "markdown";
     path: DocFilePath;
     isArchived: boolean;
-    content: DocFileMdContent<T>;
+    content: DocFileMdContentGenerics<T>;
 };
 /**
  * Other file type (non-markdown)
@@ -675,15 +675,18 @@ type DocFileUnknown = z.infer<typeof zDocFileUnknown>;
 /**
  * File union type (index.md, regular md, other)
  */
-type DocFile<T extends DocCustomSchema = DocCustomSchema> = DocFileIndex<T> | DocFileMd<T> | DocFileUnknown;
-type DocDirectoryFile<T extends DocCustomSchema = DocCustomSchema> = DocFileMd<T> | DocFileUnknown;
+type DocFileGenerics<T extends DocCustomSchemaGenerics = DocCustomSchemaGenerics> = DocFileIndexGenerics<T> | DocFileMdGenerics<T> | DocFileUnknown;
+type DocDirectoryFileGenerics<T extends DocCustomSchemaGenerics = DocCustomSchemaGenerics> = DocFileMdGenerics<T> | DocFileUnknown;
+type DocFileIndex = z.infer<typeof zDocFileIndex>;
+type DocFileMd = z.infer<typeof zDocFileMd>;
+type DocFile = DocFileIndex | DocFileMd | DocFileUnknown;
 /**
  * Directory FrontMatter type
  */
-type DocFileIndexMeta<T extends DocCustomSchema = DocCustomSchema> = {
+type DocFileIndexMetaGenerics<T extends DocCustomSchemaGenerics = DocCustomSchemaGenerics> = {
     type: "index-meta";
     icon: string | null;
-    schema: DocFileIndexSchema<keyof T>;
+    schema: DocFileIndexSchemaGenerics<keyof T>;
 };
 /**
  * Relation options type
@@ -719,11 +722,11 @@ type DetectFileType<T extends string> = IsIndexMd<T> extends true ? "index" : En
 /**
  * Map file type to reference class
  */
-type FileTypeToReference<FileType extends string, Schema extends DocCustomSchema> = FileType extends "index" ? DocFileIndexReference<Schema> : FileType extends "markdown" ? DocFileMdReference<Schema> : DocFileUnknownReference;
+type FileTypeToReferenceGenerics<FileType extends string, Schema extends DocCustomSchemaGenerics> = FileType extends "index" ? DocFileIndexReference<Schema> : FileType extends "markdown" ? DocFileMdReference<Schema> : DocFileUnknownReference;
 /**
  * Infer reference type from path
  */
-type InferReference<Path extends string, Schema extends DocCustomSchema> = FileTypeToReference<DetectFileType<Path>, Schema>;
+type InferReference<Path extends string, Schema extends DocCustomSchemaGenerics> = FileTypeToReferenceGenerics<DetectFileType<Path>, Schema>;
 /**
  * File path information type
  */
@@ -731,7 +734,7 @@ type DocFilePath = z.infer<typeof zDocFilePath>;
 /**
  * Markdown content information type
  */
-type DocFileMdContent<T extends DocCustomSchema = DocCustomSchema> = {
+type DocFileMdContentGenerics<T extends DocCustomSchemaGenerics = DocCustomSchemaGenerics> = {
     type: "markdown-content";
     body: string;
     title: string;
@@ -741,20 +744,20 @@ type DocFileMdContent<T extends DocCustomSchema = DocCustomSchema> = {
 /**
  * Index file content information type
  */
-type DocFileIndexContent<T extends DocCustomSchema = DocCustomSchema> = {
+type DocFileIndexContentGenerics<T extends DocCustomSchemaGenerics = DocCustomSchemaGenerics> = {
     type: "markdown-index";
     body: string;
     title: string;
     description: string;
-    meta: DocFileIndexMeta<T>;
+    meta: DocFileIndexMetaGenerics<T>;
 };
 /**
  * Directory response type (re-export from server package)
  */
-type DocDirectory<T extends DocCustomSchema> = {
+type DocDirectoryGenerics<T extends DocCustomSchemaGenerics> = {
     cwd: string;
-    indexFile: DocFileIndex<T>;
-    files: DocFile<T>[];
+    indexFile: DocFileIndexGenerics<T>;
+    files: DocFileGenerics<T>[];
     relations: DocRelation[];
 };
 type RecordKey = PropertyKey;
@@ -776,7 +779,7 @@ type FieldValueType<Type, Required> = Required extends true ? BaseFieldValueType
 /**
  * Extract required field keys
  */
-type RequiredKeys<T extends DocCustomSchema> = {
+type RequiredKeys<T extends DocCustomSchemaGenerics> = {
     [K in keyof T]: T[K] extends {
         required: true;
     } ? K : never;
@@ -784,7 +787,7 @@ type RequiredKeys<T extends DocCustomSchema> = {
 /**
  * Extract optional field keys
  */
-type OptionalKeys<T extends DocCustomSchema> = {
+type OptionalKeys<T extends DocCustomSchemaGenerics> = {
     [K in keyof T]: T[K] extends {
         required: true;
     } ? never : K;
@@ -792,7 +795,7 @@ type OptionalKeys<T extends DocCustomSchema> = {
 /**
  * Generate expected value type from schema (considering required)
  */
-type SchemaToValueType<T extends DocCustomSchema> = {
+type SchemaToValueType<T extends DocCustomSchemaGenerics> = {
     [K in RequiredKeys<T>]: BaseFieldValueType<ExtractFieldType<T[K]>>;
 } & {
     [K in OptionalKeys<T>]?: BaseFieldValueType<ExtractFieldType<T[K]>> | null;
@@ -800,12 +803,12 @@ type SchemaToValueType<T extends DocCustomSchema> = {
 /**
  * Helper type for type-safe property access
  */
-type GetValueType<T extends DocCustomSchema, K extends keyof T> = K extends RequiredKeys<T> ? BaseFieldValueType<ExtractFieldType<T[K]>> : BaseFieldValueType<ExtractFieldType<T[K]>> | undefined | null;
-type GetIndexFieldType<Schema extends DocFileIndexSchema<RecordKey>, K extends keyof Schema> = Schema[K] extends DocFileIndexSchemaField ? Schema[K] : never;
+type GetValueType<T extends DocCustomSchemaGenerics, K extends keyof T> = K extends RequiredKeys<T> ? BaseFieldValueType<ExtractFieldType<T[K]>> : BaseFieldValueType<ExtractFieldType<T[K]>> | undefined | null;
+type GetIndexFieldType<Schema extends DocFileIndexSchemaGenerics<RecordKey>, K extends keyof Schema> = Schema[K] extends DocFileIndexSchemaField ? Schema[K] : never;
 /**
  * Infers DocFileMd type from the result of defineSchema
  */
-type InferDocFileMd<T> = T extends DocCustomSchema ? DocFileMd<T> : never;
+type InferDocFileMd<T> = T extends DocCustomSchemaGenerics ? DocFileMdGenerics<T> : never;
 
 /**
  * Relation file
@@ -1197,10 +1200,10 @@ declare class DocSchemaFieldMultiNumberValue<T extends RecordKey> {
 /**
  * Type-safe schema value object
  */
-declare class DocFileIndexSchemaValue<T extends DocCustomSchema> {
-    readonly value: DocFileIndexSchema<keyof T>;
+declare class DocFileIndexSchemaValue<T extends DocCustomSchemaGenerics> {
+    readonly value: DocFileIndexSchemaGenerics<keyof T>;
     readonly customSchema: T;
-    constructor(value: DocFileIndexSchema<keyof T>, customSchema: T);
+    constructor(value: DocFileIndexSchemaGenerics<keyof T>, customSchema: T);
     /**
      * Get list of field names
      * Automatically type-safe when using Zod schema
@@ -1213,7 +1216,7 @@ declare class DocFileIndexSchemaValue<T extends DocCustomSchema> {
     field<K extends keyof T>(key: K): T[K]["type"] extends infer Type ? Type extends "text" ? DocSchemaFieldTextValue<K> : Type extends "number" ? DocSchemaFieldNumberValue<K> : Type extends "boolean" ? DocSchemaFieldBooleanValue<K> : Type extends "relation" ? DocSchemaFieldRelationValue<K> : Type extends "select-text" ? DocSchemaFieldSelectTextValue<K> : Type extends "select-number" ? DocSchemaFieldSelectNumberValue<K> : Type extends "multi-text" ? DocSchemaFieldMultiTextValue<K> : Type extends "multi-number" ? DocSchemaFieldMultiNumberValue<K> : Type extends "multi-relation" ? DocSchemaFieldMultiRelationValue<K> : Type extends "multi-select-text" ? DocSchemaFieldMultiSelectTextValue<K> : Type extends "multi-select-number" ? DocSchemaFieldMultiSelectNumberValue<K> : never : never;
     relation<K extends keyof T>(key: K): DocSchemaFieldRelationValue<K>;
     multiRelation<K extends keyof T>(key: K): DocSchemaFieldMultiRelationValue<K>;
-    toJson(): DocFileIndexSchema<keyof T>;
+    toJson(): DocFileIndexSchemaGenerics<keyof T>;
     /**
      * Create empty schema entity
      * biome-ignore lint/complexity/noBannedTypes: {} as DocCustomSchema
@@ -1224,12 +1227,12 @@ declare class DocFileIndexSchemaValue<T extends DocCustomSchema> {
 /**
  * File: index.md > content > FrontMatter
  */
-declare class DocFileIndexMetaValue<T extends DocCustomSchema> {
-    readonly value: DocFileIndexMeta<T>;
+declare class DocFileIndexMetaValue<T extends DocCustomSchemaGenerics> {
+    readonly value: DocFileIndexMetaGenerics<T>;
     readonly customSchema: T;
     private readonly config;
     private readonly additionalProperties;
-    constructor(value: DocFileIndexMeta<T>, customSchema: T, config: DocClientConfig, additionalProperties?: Record<string, unknown>);
+    constructor(value: DocFileIndexMetaGenerics<T>, customSchema: T, config: DocClientConfig, additionalProperties?: Record<string, unknown>);
     /**
      * Get icon
      */
@@ -1249,16 +1252,16 @@ declare class DocFileIndexMetaValue<T extends DocCustomSchema> {
     /**
      * Update schema field
      */
-    withSchema(value: DocFileIndexSchema<keyof T>): DocFileIndexMetaValue<T>;
+    withSchema(value: DocFileIndexSchemaGenerics<keyof T>): DocFileIndexMetaValue<T>;
     /**
      * Return a new instance with an unknown schema
      * Allows accepting Record<string, unknown> schemas from external sources
      */
-    withUnknownSchema(draft: Record<string, unknown>): DocFileIndexMetaValue<DocCustomSchema>;
+    withUnknownSchema(draft: Record<string, unknown>): DocFileIndexMetaValue<DocCustomSchemaGenerics>;
     /**
      * Output in JSON format
      */
-    toJson(): DocFileIndexMeta<T>;
+    toJson(): DocFileIndexMetaGenerics<T>;
     /**
      * Output in YAML format
      */
@@ -1266,15 +1269,15 @@ declare class DocFileIndexMetaValue<T extends DocCustomSchema> {
     /**
      * Generate from Markdown text (can process incomplete data)
      */
-    static from<T extends DocCustomSchema>(markdownText: string, customSchema: T, config: DocClientConfig): DocFileIndexMetaValue<T>;
+    static from<T extends DocCustomSchemaGenerics>(markdownText: string, customSchema: T, config: DocClientConfig): DocFileIndexMetaValue<T>;
     /**
      * Generate directly from data (can process incomplete data)
      */
-    static fromRecord<T extends DocCustomSchema>(record: Record<string, unknown>, customSchema: T, config: DocClientConfig): DocFileIndexMetaValue<T>;
+    static fromRecord<T extends DocCustomSchemaGenerics>(record: Record<string, unknown>, customSchema: T, config: DocClientConfig): DocFileIndexMetaValue<T>;
     /**
      * Generate empty FrontMatter
      */
-    static empty<T extends DocCustomSchema>(customSchema: T, config: DocClientConfig): DocFileIndexMetaValue<T>;
+    static empty<T extends DocCustomSchemaGenerics>(customSchema: T, config: DocClientConfig): DocFileIndexMetaValue<T>;
     /**
      * Extract icon
      */
@@ -1287,17 +1290,17 @@ declare class DocFileIndexMetaValue<T extends DocCustomSchema> {
      * Normalize entire schema
      */
     private static normalizeSchema;
-    static emptySchema<T extends DocCustomSchema>(customSchema: T): DocFileIndexSchema<keyof T>;
+    static emptySchema<T extends DocCustomSchemaGenerics>(customSchema: T): DocFileIndexSchemaGenerics<keyof T>;
 }
 
 /**
  * File: index.md > content
  */
-declare class DocFileIndexContentValue<T extends DocCustomSchema> {
-    readonly value: DocFileIndexContent<T>;
+declare class DocFileIndexContentValue<T extends DocCustomSchemaGenerics> {
+    readonly value: DocFileIndexContentGenerics<T>;
     private readonly customSchema;
     private readonly config;
-    constructor(value: DocFileIndexContent<T>, customSchema: T, config: DocClientConfig);
+    constructor(value: DocFileIndexContentGenerics<T>, customSchema: T, config: DocClientConfig);
     /**
      * Content body (does not include frontMatter)
      */
@@ -1325,7 +1328,7 @@ declare class DocFileIndexContentValue<T extends DocCustomSchema> {
     /**
      * Generate from Markdown text
      */
-    static fromMarkdown<T extends DocCustomSchema>(markdown: string, customSchema: T, config: DocClientConfig): DocFileIndexContentValue<T>;
+    static fromMarkdown<T extends DocCustomSchemaGenerics>(markdown: string, customSchema: T, config: DocClientConfig): DocFileIndexContentValue<T>;
     /**
      * Generate complete Markdown text
      */
@@ -1337,11 +1340,11 @@ declare class DocFileIndexContentValue<T extends DocCustomSchema> {
     /**
      * Update FrontMatter
      */
-    withMeta(meta: DocFileIndexMeta<T>): DocFileIndexContentValue<T>;
+    withMeta(meta: DocFileIndexMetaGenerics<T>): DocFileIndexContentValue<T>;
     /**
      * Generate default index.md content
      */
-    static empty<T extends DocCustomSchema = DocCustomSchema>(directoryName: string, customSchema: T, config: DocClientConfig): DocFileIndexContentValue<T>;
+    static empty<T extends DocCustomSchemaGenerics = DocCustomSchemaGenerics>(directoryName: string, customSchema: T, config: DocClientConfig): DocFileIndexContentValue<T>;
     /**
      * Generate complete text combining FrontMatter and body
      */
@@ -1349,17 +1352,17 @@ declare class DocFileIndexContentValue<T extends DocCustomSchema> {
     /**
      * Output in JSON format
      */
-    toJson(): DocFileIndexContent<T>;
+    toJson(): DocFileIndexContentGenerics<T>;
 }
 
 /**
  * Document directory entity
  */
-declare class DocFileIndexEntity<T extends DocCustomSchema> {
-    readonly value: DocFileIndex<T>;
+declare class DocFileIndexEntity<T extends DocCustomSchemaGenerics> {
+    readonly value: DocFileIndexGenerics<T>;
     private readonly customSchema;
     private readonly config;
-    constructor(value: DocFileIndex<T>, customSchema: T, config?: DocClientConfig);
+    constructor(value: DocFileIndexGenerics<T>, customSchema: T, config?: DocClientConfig);
     /**
      * Content
      */
@@ -1382,7 +1385,7 @@ declare class DocFileIndexEntity<T extends DocCustomSchema> {
     toJson(): z.infer<typeof zDocFileIndex>;
 }
 
-type Props$5<T extends DocCustomSchema> = {
+type Props$5<T extends DocCustomSchemaGenerics> = {
     customSchema: T;
     path: string;
     fileSystem: DocFileSystem;
@@ -1392,7 +1395,7 @@ type Props$5<T extends DocCustomSchema> = {
 /**
  * File reference class
  */
-declare class DocFileIndexReference<T extends DocCustomSchema> {
+declare class DocFileIndexReference<T extends DocCustomSchemaGenerics> {
     private readonly props;
     private readonly pathSystem;
     private readonly customSchema;
@@ -1403,7 +1406,7 @@ declare class DocFileIndexReference<T extends DocCustomSchema> {
     get fileFullPath(): string;
     get durectoryPath(): string;
     read(): Promise<DocFileIndexEntity<T> | Error>;
-    readSchemaValue(): Promise<DocFileIndexSchema<RecordKey>>;
+    readSchemaValue(): Promise<DocFileIndexSchemaGenerics<RecordKey>>;
     /**
      * Read file content
      */
@@ -1456,12 +1459,12 @@ declare class DocFileIndexReference<T extends DocCustomSchema> {
     restore(archiveDirectoryName?: string): Promise<DocFileIndexReference<T>>;
 }
 
-type DocFileDirectoryReference<T extends DocCustomSchema> = DocFileMdReference<T> | DocFileUnknownReference;
+type DocFileDirectoryReference<T extends DocCustomSchemaGenerics> = DocFileMdReference<T> | DocFileUnknownReference;
 
-type DocFileEntity<T extends DocCustomSchema> = DocFileMdEntity<T> | DocFileIndexEntity<T> | DocFileUnknownEntity;
-type DocFileDirectoryEntity<T extends DocCustomSchema> = DocFileMdEntity<T> | DocFileUnknownEntity;
+type DocFileEntity<T extends DocCustomSchemaGenerics> = DocFileMdEntity<T> | DocFileIndexEntity<T> | DocFileUnknownEntity;
+type DocFileDirectoryEntity<T extends DocCustomSchemaGenerics> = DocFileMdEntity<T> | DocFileUnknownEntity;
 
-type Props$4<T extends DocCustomSchema> = {
+type Props$4<T extends DocCustomSchemaGenerics> = {
     customSchema: T;
     path: string;
     indexFileName: string;
@@ -1473,7 +1476,7 @@ type Props$4<T extends DocCustomSchema> = {
 /**
  * Directory reference
  */
-declare class DocDirectoryReference<T extends DocCustomSchema> {
+declare class DocDirectoryReference<T extends DocCustomSchemaGenerics> {
     private readonly props;
     private readonly pathSystem;
     private readonly customSchema;
@@ -1509,7 +1512,7 @@ declare class DocDirectoryReference<T extends DocCustomSchema> {
      * Get single subdirectory reference
      */
     directory(directoryName: string): DocDirectoryReference<T>;
-    directory<S extends DocCustomSchema>(directoryName: string, customSchema: S): DocDirectoryReference<S>;
+    directory<S extends DocCustomSchemaGenerics>(directoryName: string, customSchema: S): DocDirectoryReference<S>;
     indexFile(): DocFileIndexReference<T>;
     readIndexFile(): Promise<DocFileIndexEntity<T> | Error>;
     writeFile(entity: DocFileIndexEntity<T> | DocFileMdEntity<T> | DocFileUnknownEntity): Promise<Error | null>;
@@ -1698,14 +1701,14 @@ declare class DocClient {
     readonly config: DocClientConfig;
     constructor(props: Props);
     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>;
-    mdFile(relativePath: string): DocFileMdReference<DocCustomSchema>;
-    mdFile<T extends DocCustomSchema>(relativePath: string, customSchema: T): DocFileMdReference<T>;
-    indexFile(relativePath: string): DocFileIndexReference<DocCustomSchema>;
-    indexFile<T extends DocCustomSchema>(relativePath: string, customSchema: T): DocFileIndexReference<T>;
-    directory(relativePath: string): DocDirectoryReference<DocCustomSchema>;
-    directory<T extends DocCustomSchema>(relativePath: string, customSchema: T): DocDirectoryReference<T>;
+    file<Path extends string>(relativePath: Path): InferReference<Path, DocCustomSchemaGenerics>;
+    file<Path extends string, T extends DocCustomSchemaGenerics>(relativePath: Path, customSchema: T): InferReference<Path, T>;
+    mdFile(relativePath: string): DocFileMdReference<DocCustomSchemaGenerics>;
+    mdFile<T extends DocCustomSchemaGenerics>(relativePath: string, customSchema: T): DocFileMdReference<T>;
+    indexFile(relativePath: string): DocFileIndexReference<DocCustomSchemaGenerics>;
+    indexFile<T extends DocCustomSchemaGenerics>(relativePath: string, customSchema: T): DocFileIndexReference<T>;
+    directory(relativePath: string): DocDirectoryReference<DocCustomSchemaGenerics>;
+    directory<T extends DocCustomSchemaGenerics>(relativePath: string, customSchema: T): DocDirectoryReference<T>;
     fileTree(directoryPath?: string): Promise<DocTreeNode[]>;
     directoryTree(directoryPath?: string): Promise<DocTreeDirectoryNode[]>;
 }
@@ -1831,7 +1834,7 @@ declare class DocPathSystemMock extends DocPathSystem {
  *   .selectText("priority", false)
  *   .build()
  */
-declare class DocSchemaBuilder<T extends DocCustomSchema> {
+declare class DocSchemaBuilder<T extends DocCustomSchemaGenerics> {
     private schema;
     constructor(schema?: T);
     text<K extends string>(key: K, required: boolean): DocSchemaBuilder<T & Record<K, {
@@ -1914,7 +1917,7 @@ declare const defaultTestConfig: {
  *
  * type MyDoc = InferDocFileMd<typeof mySchema>
  */
-declare function defineSchema<T extends DocCustomSchema>(schema: T): T;
+declare function defineSchema<T extends DocCustomSchemaGenerics>(schema: T): T;
 /**
  * Helper functions for field definitions
  * Use when finer control is needed
@@ -2159,4 +2162,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 DocFileEntity, type DocFileIndex, type DocFileIndexContent, DocFileIndexContentValue, DocFileIndexEntity, type DocFileIndexMeta, DocFileIndexMetaValue, DocFileIndexReference, type DocFileIndexSchema, type DocFileIndexSchemaField, DocFileIndexSchemaValue, type DocFileMd, type DocFileMdContent, DocFileMdContentValue, DocFileMdEntity, type DocFileMdMeta, DocFileMdMetaValue, DocFileMdReference, type DocFilePath, DocFilePathValue, DocFileRelationReference, DocFileSystem, DocFileSystemMock, DocFileTreeSystem, type DocFileUnknown, DocFileUnknownEntity, DocFileUnknownReference, DocMarkdownSystem, type DocMetaField, type DocMetaFieldBoolean, type DocMetaFieldMultiBoolean, 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, DocSchemaBuilder, 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, assertType, defaultTestConfig, defineSchema, docCustomSchemaField, expectType, zDocClientConfig, zDocFileIndex, zDocFileIndexSchemaField, zDocFileMd, zDocFilePath, zDocFileUnknown, zDocMetaField, zDocMetaFieldBoolean, zDocMetaFieldMultiBoolean, zDocMetaFieldMultiNumber, zDocMetaFieldMultiRelation, zDocMetaFieldMultiSelectNumber, zDocMetaFieldMultiSelectText, zDocMetaFieldMultiText, zDocMetaFieldNumber, zDocMetaFieldRelation, zDocMetaFieldSelectNumber, zDocMetaFieldSelectText, zDocMetaFieldText, zDocMetaFieldType, zDocMetaFieldTypeBoolean, zDocMetaFieldTypeNumber, zDocMetaFieldTypeRelation, zDocMetaFieldTypeSelectNumber, zDocMetaFieldTypeSelectText, zDocMetaFieldTypeText, zDocRelation, zDocRelationField, zDocRelationFile, zDocSchemaFieldBoolean, zDocSchemaFieldMultiNumber, zDocSchemaFieldMultiRelation, zDocSchemaFieldMultiSelectNumber, zDocSchemaFieldMultiSelectText, zDocSchemaFieldMultiText, zDocSchemaFieldNumber, zDocSchemaFieldRelation, zDocSchemaFieldSelectNumber, zDocSchemaFieldSelectText, zDocSchemaFieldText };
+export { type BaseFieldValueType, type DetectFileType, DocClient, type DocClientConfig, 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 DocCustomSchemaGenerics, type DocDirectoryFileGenerics, type DocDirectoryGenerics, DocDirectoryPathValue, DocDirectoryReference, type DocFieldTypeLiteral, type DocFile, type DocFileEntity, type DocFileGenerics, type DocFileIndex, type DocFileIndexContentGenerics, DocFileIndexContentValue, DocFileIndexEntity, type DocFileIndexGenerics, type DocFileIndexMetaGenerics, DocFileIndexMetaValue, DocFileIndexReference, type DocFileIndexSchemaField, type DocFileIndexSchemaGenerics, DocFileIndexSchemaValue, type DocFileMd, type DocFileMdContentGenerics, DocFileMdContentValue, DocFileMdEntity, type DocFileMdGenerics, type DocFileMdMeta, DocFileMdMetaValue, DocFileMdReference, type DocFilePath, DocFilePathValue, DocFileRelationReference, DocFileSystem, DocFileSystemMock, DocFileTreeSystem, type DocFileUnknown, DocFileUnknownEntity, DocFileUnknownReference, DocMarkdownSystem, type DocMetaField, type DocMetaFieldBoolean, type DocMetaFieldMultiBoolean, 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, DocSchemaBuilder, 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, assertType, defaultTestConfig, defineSchema, docCustomSchemaField, expectType, zDocClientConfig, zDocFileIndex, zDocFileIndexSchemaField, zDocFileMd, zDocFilePath, zDocFileUnknown, zDocMetaField, zDocMetaFieldBoolean, zDocMetaFieldMultiBoolean, zDocMetaFieldMultiNumber, zDocMetaFieldMultiRelation, zDocMetaFieldMultiSelectNumber, zDocMetaFieldMultiSelectText, zDocMetaFieldMultiText, zDocMetaFieldNumber, zDocMetaFieldRelation, zDocMetaFieldSelectNumber, zDocMetaFieldSelectText, zDocMetaFieldText, zDocMetaFieldType, zDocMetaFieldTypeBoolean, zDocMetaFieldTypeNumber, zDocMetaFieldTypeRelation, zDocMetaFieldTypeSelectNumber, zDocMetaFieldTypeSelectText, zDocMetaFieldTypeText, zDocRelation, zDocRelationField, zDocRelationFile, zDocSchemaFieldBoolean, zDocSchemaFieldMultiNumber, zDocSchemaFieldMultiRelation, zDocSchemaFieldMultiSelectNumber, zDocSchemaFieldMultiSelectText, zDocSchemaFieldMultiText, zDocSchemaFieldNumber, zDocSchemaFieldRelation, zDocSchemaFieldSelectNumber, zDocSchemaFieldSelectText, zDocSchemaFieldText };

package/package.json

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