@interactive-inc/docs-client 1.0.16 → 1.0.18

package/build/index.d.ts

@@ -204,13 +204,18 @@ declare class DocFileMdContentValue<T extends DocCustomSchema> {
      */
     withDescription(description: string, defaultTitle?: string): DocFileMdContentValue<T>;
     /**
-     * Update content
+     * Update body
+     */
+    withBody(body: string): DocFileMdContentValue<T>;
+    /**
+     * @deprecated Use `withBody` instead
      */
     withContent(content: string): DocFileMdContentValue<T>;
     /**
      * Update FrontMatter
      */
     withMeta<U extends DocCustomSchema>(meta: DocFileMdMetaValue<U>): DocFileMdContentValue<U>;
+    withMeta(updater: UpdateFunction<DocFileMdMetaValue<T>>): DocFileMdContentValue<T>;
     /**
      * Update specific property of FrontMatter
      */
@@ -252,11 +257,14 @@ declare class DocFileMdEntity<T extends DocCustomSchema> {
      * Update content
      */
     withContent(content: DocFileMdContentValue<T>): DocFileMdEntity<T>;
+    withContent(updater: UpdateFunction<DocFileMdContentValue<T>>): DocFileMdEntity<T>;
     /**
      * Update path
      */
     withPath(path: DocFilePath): DocFileMdEntity<T>;
+    withPath(updater: UpdateFunction<DocFilePath>): DocFileMdEntity<T>;
     withMeta(meta: DocFileMdMetaValue<T>): DocFileMdEntity<T>;
+    withMeta(updater: UpdateFunction<DocFileMdMetaValue<T>>): DocFileMdEntity<T>;
     withTitle(title: string): DocFileMdEntity<T>;
     withDescription(description: string, defaultTitle?: string): DocFileMdEntity<T>;
     /**
@@ -384,6 +392,7 @@ declare class DocFileUnknownEntity {
      * Update path
      */
     withPath(path: DocFilePath): DocFileUnknownEntity;
+    withPath(updater: UpdateFunction<DocFilePath>): DocFileUnknownEntity;
     toJson(): z.infer<typeof zDocFileUnknown>;
 }
 
@@ -467,6 +476,10 @@ declare class DocFileUnknownReference<T extends DocCustomSchema> {
     restore(archiveDirectoryName?: string): Promise<DocFileUnknownReference<T>>;
 }
 
+/**
+ * Generic updater function type that takes a value and returns the same type
+ */
+type UpdateFunction<T> = (current: T) => T;
 /**
  * Text field type
  */
@@ -1330,7 +1343,11 @@ declare class DocFileIndexContentValue<T extends DocCustomSchema> {
     /**
      * Update content
      */
-    withContent(content: string): DocFileIndexContentValue<T>;
+    withBody(body: string): DocFileIndexContentValue<T>;
+    /**
+     * @deprecated Use `withBody` instead
+     */
+    withContent(body: string): DocFileIndexContentValue<T>;
     /**
      * Update FrontMatter
      */
@@ -1369,10 +1386,12 @@ declare class DocFileIndexEntity<T extends DocCustomSchema> {
      * Update content
      */
     withContent(content: DocFileIndexContentValue<T>): DocFileIndexEntity<T>;
+    withContent(updater: UpdateFunction<DocFileIndexContentValue<T>>): DocFileIndexEntity<T>;
     /**
      * Update path
      */
     withPath(path: DocFilePath): DocFileIndexEntity<T>;
+    withPath(updater: UpdateFunction<DocFilePath>): DocFileIndexEntity<T>;
     /**
      * z.infer<typeof zDocFileIndex>
      */
@@ -1483,6 +1502,7 @@ declare class DocDirectoryReference<T extends DocCustomSchema> {
     get indexFileName(): string;
     get indexFilePath(): string;
     get archiveDirectoryName(): string;
+    get name(): string;
     fileNames(): Promise<string[] | Error>;
     archivedFileNames(): Promise<string[] | Error>;
     filesGenerator(): AsyncGenerator<DocFileDirectoryReference<T>, void, unknown>;
@@ -2081,7 +2101,7 @@ declare class DocDirectoryPathValue {
     /**
      * Create subdirectory path
      */
-    subdirectory(dirName: string): DocDirectoryPathValue;
+    subdirectory(directoryName: string): DocDirectoryPathValue;
     /**
      * Create instance from relative path (DI support)
      */
@@ -2156,4 +2176,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, 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, type UpdateFunction, 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

@@ -1451,25 +1451,42 @@ var DocFileMdContentValue = class _DocFileMdContentValue {
     );
   }
   /**
-   * Update content
+   * Update body
    */
-  withContent(content) {
+  withBody(body) {
     const engine = new DocMarkdownSystem();
     return new _DocFileMdContentValue(
       {
         type: "markdown-content",
-        body: content,
-        title: engine.extractTitle(content) || "",
-        description: engine.extractDescription(content) || "",
+        body,
+        title: engine.extractTitle(body) || "",
+        description: engine.extractDescription(body) || "",
         meta: this.value.meta
       },
       this.customSchema
     );
   }
   /**
-   * Update FrontMatter
+   * @deprecated Use `withBody` instead
    */
-  withMeta(meta) {
+  withContent(content) {
+    return this.withBody(content);
+  }
+  withMeta(metaOrUpdater) {
+    if (typeof metaOrUpdater === "function") {
+      const updatedMeta = metaOrUpdater(this.meta());
+      return new _DocFileMdContentValue(
+        {
+          type: "markdown-content",
+          body: this.body,
+          title: this.title,
+          description: this.description,
+          meta: updatedMeta.value
+        },
+        updatedMeta.customSchema
+      );
+    }
+    const meta = metaOrUpdater;
     return new _DocFileMdContentValue(
       {
         type: "markdown-content",
@@ -1561,26 +1578,46 @@ var DocFileMdEntity = class _DocFileMdEntity {
   get path() {
     return this.value.path;
   }
-  /**
-   * Update content
-   */
-  withContent(content) {
+  withContent(contentOrUpdater) {
+    if (typeof contentOrUpdater === "function") {
+      const updatedContent = contentOrUpdater(this.content);
+      return new _DocFileMdEntity(
+        { ...this.value, content: updatedContent.value },
+        this.customSchema
+      );
+    }
     return new _DocFileMdEntity(
-      { ...this.value, content: content.value },
+      { ...this.value, content: contentOrUpdater.value },
       this.customSchema
     );
   }
-  /**
-   * Update path
-   */
-  withPath(path) {
+  withPath(pathOrUpdater) {
+    if (typeof pathOrUpdater === "function") {
+      const updatedPath = pathOrUpdater(this.path);
+      return new _DocFileMdEntity(
+        { ...this.value, path: updatedPath },
+        this.customSchema
+      );
+    }
     return new _DocFileMdEntity(
-      { ...this.value, path },
+      { ...this.value, path: pathOrUpdater },
       this.customSchema
     );
   }
-  withMeta(meta) {
-    const draft = this.content.withMeta(meta);
+  withMeta(metaOrUpdater) {
+    if (typeof metaOrUpdater === "function") {
+      const currentMeta = this.content.meta();
+      const updatedMeta = metaOrUpdater(currentMeta);
+      const draft2 = this.content.withMeta(updatedMeta);
+      return new _DocFileMdEntity(
+        {
+          ...this.value,
+          content: draft2.value
+        },
+        this.customSchema
+      );
+    }
+    const draft = this.content.withMeta(metaOrUpdater);
     return new _DocFileMdEntity(
       {
         ...this.value,
@@ -1858,7 +1895,9 @@ var DocFileRelationReference = class {
       if (file instanceof Error) {
         return file;
       }
-      if (file === null) continue;
+      if (file === null) {
+        continue;
+      }
       files.push(file);
     }
     return files;
@@ -1870,6 +1909,9 @@ var DocFileRelationReference = class {
     if (filePath.includes("index.md")) {
       return null;
     }
+    if (!filePath.endsWith(".md")) {
+      return null;
+    }
     const content = await this.fileSystem.readFile(filePath);
     if (content instanceof Error) {
       return content;
@@ -3090,20 +3132,26 @@ var DocFileIndexContentValue = class _DocFileIndexContentValue {
   /**
    * Update content
    */
-  withContent(content) {
+  withBody(body) {
     const engine = new DocMarkdownSystem();
     return new _DocFileIndexContentValue(
       {
         type: "markdown-index",
-        body: content,
-        title: engine.extractTitle(content) || "",
-        description: engine.extractDescription(content) || "",
+        body,
+        title: engine.extractTitle(body) || "",
+        description: engine.extractDescription(body) || "",
         meta: this.value.meta
       },
       this.customSchema,
       this.config
     );
   }
+  /**
+   * @deprecated Use `withBody` instead
+   */
+  withContent(body) {
+    return this.withBody(body);
+  }
   /**
    * Update FrontMatter
    */
@@ -3201,22 +3249,34 @@ var DocFileIndexEntity = class _DocFileIndexEntity {
   get path() {
     return this.value.path;
   }
-  /**
-   * Update content
-   */
-  withContent(content) {
+  withContent(contentOrUpdater) {
+    if (typeof contentOrUpdater === "function") {
+      const updatedContent = contentOrUpdater(this.content);
+      return new _DocFileIndexEntity(
+        { ...this.value, content: updatedContent.value },
+        this.customSchema,
+        this.config
+      );
+    }
     return new _DocFileIndexEntity(
-      { ...this.value, content: content.value },
-      this.customSchema
+      { ...this.value, content: contentOrUpdater.value },
+      this.customSchema,
+      this.config
     );
   }
-  /**
-   * Update path
-   */
-  withPath(path) {
+  withPath(pathOrUpdater) {
+    if (typeof pathOrUpdater === "function") {
+      const updatedPath = pathOrUpdater(this.path);
+      return new _DocFileIndexEntity(
+        { ...this.value, path: updatedPath },
+        this.customSchema,
+        this.config
+      );
+    }
     return new _DocFileIndexEntity(
-      { ...this.value, path },
-      this.customSchema
+      { ...this.value, path: pathOrUpdater },
+      this.customSchema,
+      this.config
     );
   }
   /**
@@ -3398,7 +3458,7 @@ var DocFileIndexReference = class _DocFileIndexReference {
       return [];
     }
     const refs = [];
-    const fieldKeys = Object.keys(schema);
+    const fieldKeys = Object.keys(schema.value);
     for (const key of fieldKeys) {
       const fieldValue = schema.value[key];
       if (fieldValue === void 0) continue;
@@ -3406,8 +3466,9 @@ var DocFileIndexReference = class _DocFileIndexReference {
         continue;
       }
       const field = schema.field(key);
+      const path = field.path;
       const fileRef = new DocFileRelationReference({
-        filePath: field.path,
+        filePath: path,
         fileSystem: this.fileSystem,
         pathSystem: this.pathSystem
       });
@@ -3423,8 +3484,12 @@ var DocFileIndexReference = class _DocFileIndexReference {
     const files = [];
     for (const relation of relations) {
       const entity = await relation.read();
-      if (entity === null) continue;
-      if (entity instanceof Error) continue;
+      if (entity === null) {
+        continue;
+      }
+      if (entity instanceof Error) {
+        continue;
+      }
       files.push(entity);
     }
     return files;
@@ -3939,13 +4004,17 @@ var DocFileUnknownEntity = class _DocFileUnknownEntity {
       content
     });
   }
-  /**
-   * Update path
-   */
-  withPath(path) {
+  withPath(pathOrUpdater) {
+    if (typeof pathOrUpdater === "function") {
+      const updatedPath = pathOrUpdater(this.path);
+      return new _DocFileUnknownEntity({
+        ...this.value,
+        path: updatedPath
+      });
+    }
     return new _DocFileUnknownEntity({
       ...this.value,
-      path
+      path: pathOrUpdater
     });
   }
   toJson() {
@@ -4205,6 +4274,9 @@ var DocDirectoryReference = class _DocDirectoryReference {
   get archiveDirectoryName() {
     return this.props.archiveDirectoryName;
   }
+  get name() {
+    return this.pathSystem.basename(this.relativePath);
+  }
   async fileNames() {
     const filePaths = await this.fileSystem.readDirectoryFilePaths(
       this.relativePath
@@ -6163,13 +6235,13 @@ var DocDirectoryPathValue = class _DocDirectoryPathValue {
   /**
    * Create subdirectory path
    */
-  subdirectory(dirName) {
-    const subPath = this.pathSystem.join(this.path, dirName);
+  subdirectory(directoryName) {
+    const subPath = this.pathSystem.join(this.path, directoryName);
     return new _DocDirectoryPathValue(
       {
         path: subPath,
-        name: dirName,
-        fullPath: this.pathSystem.join(this.fullPath, dirName)
+        name: directoryName,
+        fullPath: this.pathSystem.join(this.fullPath, directoryName)
       },
       this.pathSystem
     );

package/package.json

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