@interactive-inc/docs-client 1.0.14 → 1.0.15

package/build/index.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { zDocFileMd, zDocFileUnknown, zDocClientConfig, zDocFilePath, zDocFileIndexSchemaField, zDocSchemaFieldText, zDocSchemaFieldNumber, zDocSchemaFieldBoolean, zDocSchemaFieldRelation, zDocSchemaFieldSelectText, zDocSchemaFieldSelectNumber, zDocSchemaFieldMultiText, zDocSchemaFieldMultiNumber, zDocSchemaFieldMultiRelation, zDocSchemaFieldMultiSelectText, zDocSchemaFieldMultiSelectNumber, zDocRelation, zDocRelationFile, zDocMetaFieldRelation, zDocMetaFieldMultiRelation, zDocMetaFieldText, zDocMetaFieldNumber, zDocMetaFieldBoolean, zDocMetaFieldMultiText, zDocMetaFieldMultiNumber, zDocRelationField, zDocMetaField, zDocMetaFieldSelectText, zDocMetaFieldSelectNumber, zDocMetaFieldMultiSelectText, zDocMetaFieldMultiSelectNumber, zDocMetaFieldTypeText, zDocMetaFieldTypeNumber, zDocMetaFieldTypeBoolean, zDocMetaFieldTypeSelectText, zDocMetaFieldTypeSelectNumber, zDocMetaFieldTypeRelation, zDocMetaFieldType, zDocFileIndex } from './models.js';
+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';
 export { zDocCustomSchema, zDocCustomSchemaField, zDocCustomSchemaFieldBoolean, zDocCustomSchemaFieldMultiNumber, zDocCustomSchemaFieldMultiRelation, zDocCustomSchemaFieldMultiSelectNumber, zDocCustomSchemaFieldMultiSelectText, zDocCustomSchemaFieldMultiText, zDocCustomSchemaFieldNumber, zDocCustomSchemaFieldRelation, zDocCustomSchemaFieldSelectNumber, zDocCustomSchemaFieldSelectText, zDocCustomSchemaFieldText, zDocFile, zDocFileDirectory, zDocFileIndexContent, zDocFileIndexMeta, zDocFileIndexMetaInput, zDocFileIndexSchema, zDocFileIndexSchemaInput, zDocFileMdContent, zDocFileMdContentInput, zDocFileMdInput, zDocFileMdMeta, zDocFileMdMetaInput, zDocMetaFieldTypeMultiNumber, zDocMetaFieldTypeMultiRelation, zDocMetaFieldTypeMultiSelectNumber, zDocMetaFieldTypeMultiSelectText, zDocMetaFieldTypeMultiText, zDocTreeDirectoryNode, zDocTreeFileNode, zDocTreeNode } from './models.js';
 
 /**
@@ -391,27 +391,27 @@ declare class DocFileUnknownEntity {
     toJson(): z.infer<typeof zDocFileUnknown>;
 }
 
-type Props$7 = {
+type Props$7<T extends DocCustomSchema> = {
     path: string;
     fileSystem: DocFileSystem;
     pathSystem: DocPathSystem;
+    customSchema: T;
     config: DocClientConfig;
 };
 /**
  * File reference
  */
-declare class DocFileUnknownReference {
+declare class DocFileUnknownReference<T extends DocCustomSchema> {
     private readonly props;
     private readonly pathSystem;
-    constructor(props: Props$7);
+    private readonly customSchema;
+    constructor(props: Props$7<T>);
     get fileSystem(): DocFileSystem;
     get basePath(): string;
     get path(): string;
     get directoryPath(): string;
     get fileFullPath(): string;
-    get durectoryPath(): string;
-    directory<T extends DocCustomSchema>(customSchema: T): DocDirectoryReference<T>;
-    directory(): DocDirectoryReference<DocCustomSchema>;
+    directory(): DocDirectoryReference<T>;
     read(): Promise<Error | DocFileUnknownEntity>;
     /**
      * Read file content
@@ -464,11 +464,11 @@ declare class DocFileUnknownReference {
     /**
      * Move file to archive and return new reference
      */
-    archive(archiveDirectoryName?: string): Promise<DocFileUnknownReference>;
+    archive(archiveDirectoryName?: string): Promise<DocFileUnknownReference<T>>;
     /**
      * Restore file from archive and return new reference
      */
-    restore(archiveDirectoryName?: string): Promise<DocFileUnknownReference>;
+    restore(archiveDirectoryName?: string): Promise<DocFileUnknownReference<T>>;
 }
 
 /**
@@ -528,6 +528,7 @@ type DocMetaFieldMultiSelectText = z.infer<typeof zDocMetaFieldMultiSelectText>;
 type DocMetaFieldMultiSelectNumber = z.infer<typeof zDocMetaFieldMultiSelectNumber>;
 type DocMetaFieldMultiRelation = z.infer<typeof zDocMetaFieldMultiRelation>;
 type DocFileMdMeta<T extends RecordKey> = Record<T, DocMetaField>;
+type DocFileMdMetaAny = DocFileMdMeta<RecordKey>;
 type DocMetaFieldTypeText = z.infer<typeof zDocMetaFieldTypeText>;
 type DocMetaFieldTypeNumber = z.infer<typeof zDocMetaFieldTypeNumber>;
 type DocMetaFieldTypeBoolean = z.infer<typeof zDocMetaFieldTypeBoolean>;
@@ -589,7 +590,7 @@ type DocFileIndexSchemaField = z.infer<typeof zDocFileIndexSchemaField>;
 /**
  * Schema definition type
  */
-type DocFileIndexSchema<T extends RecordKey> = Record<T, DocFileIndexSchemaField>;
+type DocFileIndexSchema<T extends RecordKey = string> = Record<T, DocFileIndexSchemaField>;
 /**
  * Schema field to override
  * ex: { xxx: { type: "text", required: true } }
@@ -602,7 +603,7 @@ type DocFieldTypeLiteral = "text" | "number" | "boolean" | "relation" | "multi-t
 /**
  * Minimal schema definition type
  */
-type DocCustomSchema<T extends RecordKey = RecordKey> = Record<T, DocCustomSchemaField>;
+type DocCustomSchema<T extends RecordKey = string> = Record<T, DocCustomSchemaField>;
 /**
  * Union type for relation fields
  */
@@ -723,7 +724,7 @@ 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 FileTypeToReference<FileType extends string, Schema extends DocCustomSchema> = FileType extends "index" ? DocFileIndexReference<Schema> : FileType extends "markdown" ? DocFileMdReference<Schema> : DocFileUnknownReference<Schema>;
 /**
  * Infer reference type from path
  */
@@ -1383,7 +1384,7 @@ declare class DocFileIndexEntity<T extends DocCustomSchema> {
     /**
      * z.infer<typeof zDocFileIndex>
      */
-    toJson(): z.infer<typeof zDocFileIndex>;
+    toJson(): DocFileIndexAny;
 }
 
 type Props$5<T extends DocCustomSchema> = {
@@ -1460,7 +1461,7 @@ declare class DocFileIndexReference<T extends DocCustomSchema> {
     restore(archiveDirectoryName?: string): Promise<DocFileIndexReference<T>>;
 }
 
-type DocFileDirectoryReference<T extends DocCustomSchema> = DocFileMdReference<T> | DocFileUnknownReference;
+type DocFileDirectoryReference<T extends DocCustomSchema> = DocFileMdReference<T> | DocFileUnknownReference<T>;
 
 type DocFileEntity<T extends DocCustomSchema> = DocFileMdEntity<T> | DocFileIndexEntity<T> | DocFileUnknownEntity;
 type DocFileDirectoryEntity<T extends DocCustomSchema> = DocFileMdEntity<T> | DocFileUnknownEntity;
@@ -2163,4 +2164,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, DocFileMdMetaValue, DocFileMdReference, type DocFilePath, DocFilePathValue, DocFileRelationReference, DocFileSystem, DocFileSystemMock, 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, 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, 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 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, DocFileSystem, DocFileSystemMock, 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, 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, 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/build/index.js

@@ -3251,7 +3251,7 @@ var DocFileIndexEntity = class _DocFileIndexEntity {
    * z.infer<typeof zDocFileIndex>
    */
   toJson() {
-    return zDocFileIndex.parse(this.value);
+    return this.value;
   }
 };
 
@@ -3772,6 +3772,19 @@ var DocFileMdReference = class _DocFileMdReference {
     return this.fileSystem.getFileCreatedTime(this.path);
   }
   directory() {
+    const paths = this.directoryPath.split(this.pathSystem.separator);
+    if (paths[paths.length - 1] === this.props.config.archiveDirectoryName) {
+      const path = paths.slice(0, -1).join(this.pathSystem.separator);
+      return new DocDirectoryReference({
+        archiveDirectoryName: this.props.config.archiveDirectoryName,
+        indexFileName: this.props.config.indexFileName,
+        fileSystem: this.fileSystem,
+        path,
+        pathSystem: this.pathSystem,
+        customSchema: this.customSchema,
+        config: this.props.config
+      });
+    }
     return new DocDirectoryReference({
       archiveDirectoryName: this.props.config.archiveDirectoryName,
       indexFileName: this.props.config.indexFileName,
@@ -3973,9 +3986,11 @@ var DocFileUnknownReference = class _DocFileUnknownReference {
   constructor(props) {
     this.props = props;
     this.pathSystem = props.pathSystem;
+    this.customSchema = props.customSchema;
     Object.freeze(this);
   }
   pathSystem;
+  customSchema;
   get fileSystem() {
     return this.props.fileSystem;
   }
@@ -3991,17 +4006,27 @@ var DocFileUnknownReference = class _DocFileUnknownReference {
   get fileFullPath() {
     return this.pathSystem.join(this.basePath, this.path);
   }
-  get durectoryPath() {
-    return this.pathSystem.dirname(this.path);
-  }
-  directory(customSchema) {
+  directory() {
+    const paths = this.directoryPath.split(this.pathSystem.separator);
+    if (paths[paths.length - 1] === this.props.config.archiveDirectoryName) {
+      const path = paths.slice(0, -1).join(this.pathSystem.separator);
+      return new DocDirectoryReference({
+        archiveDirectoryName: this.props.config.archiveDirectoryName,
+        indexFileName: this.props.config.indexFileName,
+        fileSystem: this.fileSystem,
+        path,
+        pathSystem: this.pathSystem,
+        customSchema: this.customSchema,
+        config: this.props.config
+      });
+    }
     return new DocDirectoryReference({
       archiveDirectoryName: this.props.config.archiveDirectoryName,
       indexFileName: this.props.config.indexFileName,
       fileSystem: this.fileSystem,
       path: this.directoryPath,
       pathSystem: this.pathSystem,
-      customSchema: customSchema ?? {},
+      customSchema: this.customSchema,
       config: this.props.config
     });
   }
@@ -4138,7 +4163,8 @@ var DocFileUnknownReference = class _DocFileUnknownReference {
       path: archivePath,
       fileSystem: this.fileSystem,
       pathSystem: this.pathSystem,
-      config: this.props.config
+      config: this.props.config,
+      customSchema: this.customSchema
     });
   }
   /**
@@ -4163,7 +4189,8 @@ var DocFileUnknownReference = class _DocFileUnknownReference {
       path: restorePath,
       fileSystem: this.fileSystem,
       pathSystem: this.pathSystem,
-      config: this.props.config
+      config: this.props.config,
+      customSchema: this.customSchema
     });
   }
 };
@@ -4245,7 +4272,8 @@ var DocDirectoryReference = class _DocDirectoryReference {
         path: this.pathSystem.join(this.relativePath, fileName),
         fileSystem: this.fileSystem,
         pathSystem: this.pathSystem,
-        config: this.props.config
+        config: this.props.config,
+        customSchema: this.customSchema
       });
     }
     const archivedFileNames = await this.archivedFileNames();
@@ -4274,7 +4302,8 @@ var DocDirectoryReference = class _DocDirectoryReference {
         ),
         fileSystem: this.fileSystem,
         pathSystem: this.pathSystem,
-        config: this.props.config
+        config: this.props.config,
+        customSchema: this.customSchema
       });
     }
   }
@@ -4321,7 +4350,8 @@ var DocDirectoryReference = class _DocDirectoryReference {
       path: filePath,
       fileSystem: this.fileSystem,
       pathSystem: this.pathSystem,
-      config: this.props.config
+      config: this.props.config,
+      customSchema: this.customSchema
     });
   }
   mdFile(fileName) {
@@ -4963,7 +4993,8 @@ var DocClient = class {
       path: relativePath,
       fileSystem: this.fileSystem,
       pathSystem: this.pathSystem,
-      config: this.config
+      config: this.config,
+      customSchema: {}
     });
   }
   /**

package/package.json

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