@interactive-inc/docs-client 1.1.0 → 1.1.1

package/build/index.js

@@ -1,5 +1,7 @@
+import { z } from 'zod';
+import { stringify, parse } from 'yaml';
+
 // lib/models.ts
-import { z } from "zod";
 var zDocFilePath = z.object({
   name: z.string(),
   path: z.string(),
@@ -19,7 +21,7 @@ var zDocMetaFieldTypeMultiSelectText = z.literal("multi-select-text");
 var zDocMetaFieldTypeMultiSelectNumber = z.literal(
   "multi-select-number"
 );
-var zDocMetaFieldType = z.union([
+z.union([
   zDocMetaFieldTypeText,
   zDocMetaFieldTypeNumber,
   zDocMetaFieldTypeBoolean,
@@ -222,13 +224,13 @@ var zDocCustomSchemaField = z.union([
   zDocCustomSchemaFieldMultiSelectText,
   zDocCustomSchemaFieldMultiSelectNumber
 ]);
-var zDocCustomSchema = z.record(z.string(), zDocCustomSchemaField);
+z.record(z.string(), zDocCustomSchemaField);
 var zDocFileIndexMeta = z.object({
   type: z.literal("index-meta"),
   icon: z.string().nullable(),
   schema: zDocFileIndexSchema
 });
-var zDocFileIndexMetaInput = z.object({
+z.object({
   type: z.literal("index-meta"),
   icon: z.string().nullable().or(z.undefined()),
   schema: zDocFileIndexSchemaInput
@@ -288,14 +290,14 @@ var zDocFileMd = z.object({
   content: zDocFileMdContent,
   isArchived: z.boolean()
 });
-var zDocFileMdInput = z.object({
+z.object({
   type: z.literal("markdown"),
   path: zDocFilePath,
   content: zDocFileMdContentInput,
   isArchived: z.boolean()
 });
-var zDocFile = z.union([zDocFileIndex, zDocFileMd, zDocFileUnknown]);
-var zDocFileDirectory = z.union([zDocFileMd, zDocFileUnknown]);
+z.union([zDocFileIndex, zDocFileMd, zDocFileUnknown]);
+z.union([zDocFileMd, zDocFileUnknown]);
 var zDocTreeFileNode = z.object({
   type: z.literal("file"),
   name: z.string(),
@@ -323,9 +325,6 @@ var zDocClientConfig = z.object({
   directoryExcludes: z.array(z.string())
 });
 
-// lib/values/doc-file-index-content-value.ts
-import { stringify as stringify2 } from "yaml";
-
 // lib/modules/markdown-system/doc-markdown-system.ts
 var DocMarkdownSystem = class {
   frontMatterSeparator = "---";
@@ -469,9 +468,6 @@ ${text}`.trim();
   }
 };
 
-// lib/values/doc-file-index-meta-value.ts
-import { parse, stringify } from "yaml";
-
 // lib/constants.ts
 var INDEX_META = "index-meta";
 var DOC_NODE_TYPE_DIRECTORY = "directory";
@@ -1686,7 +1682,7 @@ schema: {}
       icon: this.meta().icon,
       schema: this.meta().schema().toJson()
     };
-    const yamlStr = stringify2(yamlData).trim();
+    const yamlStr = stringify(yamlData).trim();
     const text = `---
 ${yamlStr}
 ---
@@ -1858,9 +1854,6 @@ var DocFilePathValue = class _DocFilePathValue {
   }
 };
 
-// lib/values/doc-file-md-meta-value.ts
-import { parse as parse2, stringify as stringify3 } from "yaml";
-
 // lib/values/doc-custom-schema-field/doc-custom-schema-field-boolean-value.ts
 var DocCustomSchemaFieldBooleanValue = class _DocCustomSchemaFieldBooleanValue {
   constructor(key, value) {
@@ -2703,7 +2696,7 @@ var DocFileMdMetaValue = class _DocFileMdMetaValue {
     return this.value;
   }
   toYaml() {
-    return stringify3(this.value).trim();
+    return stringify(this.value).trim();
   }
   validateValue(value, schema) {
     if (Object.keys(schema).length === 0) {
@@ -2730,7 +2723,7 @@ var DocFileMdMetaValue = class _DocFileMdMetaValue {
    * Generate from Markdown text
    */
   static fromYamlText(yamlText, customSchema) {
-    const yamlRecord = parse2(yamlText);
+    const yamlRecord = parse(yamlText);
     const record = zDocFileMdMetaInput.transform((meta) => {
       const result = {};
       for (const [key, value] of Object.entries(meta)) {
@@ -3505,7 +3498,7 @@ var DocFileIndexReference = class _DocFileIndexReference {
    * Get last modified date
    */
   async lastModified() {
-    return this.fileSystem.getFileModifiedTime(this.filePath);
+    return this.fileSystem.getFileUpdatedTime(this.filePath);
   }
   /**
    * Get file creation date
@@ -3771,7 +3764,7 @@ var DocFileUnknownReference = class _DocFileUnknownReference {
    * Get file last modified time
    */
   async lastModified() {
-    return this.fileSystem.getFileModifiedTime(this.path);
+    return this.fileSystem.getFileUpdatedTime(this.path);
   }
   /**
    * Get file creation time
@@ -4407,7 +4400,7 @@ var DocFileMdReference = class _DocFileMdReference {
    * Get file last modified time
    */
   async lastModified() {
-    return this.fileSystem.getFileModifiedTime(this.path);
+    return this.fileSystem.getFileUpdatedTime(this.path);
   }
   /**
    * Get file creation time
@@ -5020,13 +5013,14 @@ var DocClient = class {
       directoryExcludes: [".vitepress"]
     };
     this.config = props.config ? zDocClientConfig.parse(props.config) : defaultConfig;
-    this.fileTreeSystem = props.fileTreeSystem ?? new DocFileTreeSystem({
+    const fileTreeSystem = new DocFileTreeSystem({
       fileSystem: this.fileSystem,
       pathSystem: this.pathSystem,
       indexFileName: this.config.indexFileName,
       archiveDirectoryName: this.config.archiveDirectoryName,
       config: this.config
     });
+    this.fileTreeSystem = props.fileTreeSystem ?? fileTreeSystem;
   }
   basePath() {
     return this.fileSystem.getBasePath();
@@ -5277,16 +5271,22 @@ var docCustomSchemaField = {
       required
     };
   },
-  relation(required) {
+  relation(required, path) {
     return {
       type: "relation",
-      required
+      required,
+      title: null,
+      description: null,
+      path
     };
   },
-  multiRelation(required) {
+  multiRelation(required, path) {
     return {
       type: "multi-relation",
-      required
+      required,
+      title: null,
+      description: null,
+      path
     };
   },
   selectText(required) {
@@ -5686,108 +5686,5 @@ var DocRelationFieldValue = class _DocRelationFieldValue {
     return new _DocRelationFieldValue(props);
   }
 };
-export {
-  DocClient,
-  DocCustomSchemaFieldValue,
-  DocDirectoryPathValue,
-  DocDirectoryReference,
-  DocFileIndexContentValue,
-  DocFileIndexEntity,
-  DocFileIndexMetaValue,
-  DocFileIndexReference,
-  DocFileIndexSchemaValue,
-  DocFileMdContentValue,
-  DocFileMdEntity,
-  DocFileMdMetaValue,
-  DocFileMdReference,
-  DocFilePathValue,
-  DocFileRelationReference,
-  DocFileTreeSystem,
-  DocFileUnknownEntity,
-  DocFileUnknownReference,
-  DocMarkdownSystem,
-  DocPathSystem,
-  DocPathSystemMock,
-  DocRelationFieldValue,
-  DocRelationFileValue,
-  DocRelationValue,
-  DocTreeDirectoryNodeValue,
-  DocTreeFileNodeValue,
-  assertType,
-  defaultTestConfig,
-  defineSchema,
-  docCustomSchemaField,
-  expectType,
-  zDocClientConfig,
-  zDocCustomSchema,
-  zDocCustomSchemaField,
-  zDocCustomSchemaFieldBoolean,
-  zDocCustomSchemaFieldMultiNumber,
-  zDocCustomSchemaFieldMultiRelation,
-  zDocCustomSchemaFieldMultiSelectNumber,
-  zDocCustomSchemaFieldMultiSelectText,
-  zDocCustomSchemaFieldMultiText,
-  zDocCustomSchemaFieldNumber,
-  zDocCustomSchemaFieldRelation,
-  zDocCustomSchemaFieldSelectNumber,
-  zDocCustomSchemaFieldSelectText,
-  zDocCustomSchemaFieldText,
-  zDocFile,
-  zDocFileDirectory,
-  zDocFileIndex,
-  zDocFileIndexContent,
-  zDocFileIndexMeta,
-  zDocFileIndexMetaInput,
-  zDocFileIndexSchema,
-  zDocFileIndexSchemaField,
-  zDocFileIndexSchemaInput,
-  zDocFileMd,
-  zDocFileMdContent,
-  zDocFileMdContentInput,
-  zDocFileMdInput,
-  zDocFileMdMeta,
-  zDocFileMdMetaInput,
-  zDocFilePath,
-  zDocFileUnknown,
-  zDocMetaField,
-  zDocMetaFieldBoolean,
-  zDocMetaFieldMultiNumber,
-  zDocMetaFieldMultiRelation,
-  zDocMetaFieldMultiSelectNumber,
-  zDocMetaFieldMultiSelectText,
-  zDocMetaFieldMultiText,
-  zDocMetaFieldNumber,
-  zDocMetaFieldRelation,
-  zDocMetaFieldSelectNumber,
-  zDocMetaFieldSelectText,
-  zDocMetaFieldText,
-  zDocMetaFieldType,
-  zDocMetaFieldTypeBoolean,
-  zDocMetaFieldTypeMultiNumber,
-  zDocMetaFieldTypeMultiRelation,
-  zDocMetaFieldTypeMultiSelectNumber,
-  zDocMetaFieldTypeMultiSelectText,
-  zDocMetaFieldTypeMultiText,
-  zDocMetaFieldTypeNumber,
-  zDocMetaFieldTypeRelation,
-  zDocMetaFieldTypeSelectNumber,
-  zDocMetaFieldTypeSelectText,
-  zDocMetaFieldTypeText,
-  zDocRelation,
-  zDocRelationField,
-  zDocRelationFile,
-  zDocSchemaFieldBoolean,
-  zDocSchemaFieldMultiNumber,
-  zDocSchemaFieldMultiRelation,
-  zDocSchemaFieldMultiSelectNumber,
-  zDocSchemaFieldMultiSelectText,
-  zDocSchemaFieldMultiText,
-  zDocSchemaFieldNumber,
-  zDocSchemaFieldRelation,
-  zDocSchemaFieldSelectNumber,
-  zDocSchemaFieldSelectText,
-  zDocSchemaFieldText,
-  zDocTreeDirectoryNode,
-  zDocTreeFileNode,
-  zDocTreeNode
-};
+
+export { DocClient, DocCustomSchemaFieldValue, DocDirectoryPathValue, DocDirectoryReference, DocFileIndexContentValue, DocFileIndexEntity, DocFileIndexMetaValue, DocFileIndexReference, DocFileIndexSchemaValue, DocFileMdContentValue, DocFileMdEntity, DocFileMdMetaValue, DocFileMdReference, DocFilePathValue, DocFileRelationReference, DocFileTreeSystem, DocFileUnknownEntity, DocFileUnknownReference, DocMarkdownSystem, DocPathSystem, DocPathSystemMock, DocRelationFieldValue, DocRelationFileValue, DocRelationValue, DocTreeDirectoryNodeValue, DocTreeFileNodeValue, assertType, defaultTestConfig, defineSchema, docCustomSchemaField, expectType };

package/build/models.js

@@ -1,5 +1,6 @@
+import { z } from 'zod';
+
 // lib/models.ts
-import { z } from "zod";
 var zDocFilePath = z.object({
   name: z.string(),
   path: z.string(),
@@ -322,77 +323,5 @@ var zDocClientConfig = z.object({
   indexMetaIncludes: z.array(z.string()),
   directoryExcludes: z.array(z.string())
 });
-export {
-  zDocClientConfig,
-  zDocCustomSchema,
-  zDocCustomSchemaField,
-  zDocCustomSchemaFieldBoolean,
-  zDocCustomSchemaFieldMultiNumber,
-  zDocCustomSchemaFieldMultiRelation,
-  zDocCustomSchemaFieldMultiSelectNumber,
-  zDocCustomSchemaFieldMultiSelectText,
-  zDocCustomSchemaFieldMultiText,
-  zDocCustomSchemaFieldNumber,
-  zDocCustomSchemaFieldRelation,
-  zDocCustomSchemaFieldSelectNumber,
-  zDocCustomSchemaFieldSelectText,
-  zDocCustomSchemaFieldText,
-  zDocFile,
-  zDocFileDirectory,
-  zDocFileIndex,
-  zDocFileIndexContent,
-  zDocFileIndexMeta,
-  zDocFileIndexMetaInput,
-  zDocFileIndexSchema,
-  zDocFileIndexSchemaField,
-  zDocFileIndexSchemaInput,
-  zDocFileMd,
-  zDocFileMdContent,
-  zDocFileMdContentInput,
-  zDocFileMdInput,
-  zDocFileMdMeta,
-  zDocFileMdMetaInput,
-  zDocFilePath,
-  zDocFileUnknown,
-  zDocMetaField,
-  zDocMetaFieldBoolean,
-  zDocMetaFieldMultiNumber,
-  zDocMetaFieldMultiRelation,
-  zDocMetaFieldMultiSelectNumber,
-  zDocMetaFieldMultiSelectText,
-  zDocMetaFieldMultiText,
-  zDocMetaFieldNumber,
-  zDocMetaFieldRelation,
-  zDocMetaFieldSelectNumber,
-  zDocMetaFieldSelectText,
-  zDocMetaFieldText,
-  zDocMetaFieldType,
-  zDocMetaFieldTypeBoolean,
-  zDocMetaFieldTypeMultiNumber,
-  zDocMetaFieldTypeMultiRelation,
-  zDocMetaFieldTypeMultiSelectNumber,
-  zDocMetaFieldTypeMultiSelectText,
-  zDocMetaFieldTypeMultiText,
-  zDocMetaFieldTypeNumber,
-  zDocMetaFieldTypeRelation,
-  zDocMetaFieldTypeSelectNumber,
-  zDocMetaFieldTypeSelectText,
-  zDocMetaFieldTypeText,
-  zDocRelation,
-  zDocRelationField,
-  zDocRelationFile,
-  zDocSchemaFieldBoolean,
-  zDocSchemaFieldMultiNumber,
-  zDocSchemaFieldMultiRelation,
-  zDocSchemaFieldMultiSelectNumber,
-  zDocSchemaFieldMultiSelectText,
-  zDocSchemaFieldMultiText,
-  zDocSchemaFieldNumber,
-  zDocSchemaFieldRelation,
-  zDocSchemaFieldSelectNumber,
-  zDocSchemaFieldSelectText,
-  zDocSchemaFieldText,
-  zDocTreeDirectoryNode,
-  zDocTreeFileNode,
-  zDocTreeNode
-};
+
+export { zDocClientConfig, zDocCustomSchema, zDocCustomSchemaField, zDocCustomSchemaFieldBoolean, zDocCustomSchemaFieldMultiNumber, zDocCustomSchemaFieldMultiRelation, zDocCustomSchemaFieldMultiSelectNumber, zDocCustomSchemaFieldMultiSelectText, zDocCustomSchemaFieldMultiText, zDocCustomSchemaFieldNumber, zDocCustomSchemaFieldRelation, zDocCustomSchemaFieldSelectNumber, zDocCustomSchemaFieldSelectText, zDocCustomSchemaFieldText, zDocFile, zDocFileDirectory, zDocFileIndex, zDocFileIndexContent, zDocFileIndexMeta, zDocFileIndexMetaInput, zDocFileIndexSchema, zDocFileIndexSchemaField, zDocFileIndexSchemaInput, zDocFileMd, zDocFileMdContent, zDocFileMdContentInput, zDocFileMdInput, zDocFileMdMeta, zDocFileMdMetaInput, zDocFilePath, zDocFileUnknown, zDocMetaField, zDocMetaFieldBoolean, zDocMetaFieldMultiNumber, zDocMetaFieldMultiRelation, zDocMetaFieldMultiSelectNumber, zDocMetaFieldMultiSelectText, zDocMetaFieldMultiText, zDocMetaFieldNumber, zDocMetaFieldRelation, zDocMetaFieldSelectNumber, zDocMetaFieldSelectText, zDocMetaFieldText, zDocMetaFieldType, zDocMetaFieldTypeBoolean, zDocMetaFieldTypeMultiNumber, zDocMetaFieldTypeMultiRelation, zDocMetaFieldTypeMultiSelectNumber, zDocMetaFieldTypeMultiSelectText, zDocMetaFieldTypeMultiText, zDocMetaFieldTypeNumber, zDocMetaFieldTypeRelation, zDocMetaFieldTypeSelectNumber, zDocMetaFieldTypeSelectText, zDocMetaFieldTypeText, zDocRelation, zDocRelationField, zDocRelationFile, zDocSchemaFieldBoolean, zDocSchemaFieldMultiNumber, zDocSchemaFieldMultiRelation, zDocSchemaFieldMultiSelectNumber, zDocSchemaFieldMultiSelectText, zDocSchemaFieldMultiText, zDocSchemaFieldNumber, zDocSchemaFieldRelation, zDocSchemaFieldSelectNumber, zDocSchemaFieldSelectText, zDocSchemaFieldText, zDocTreeDirectoryNode, zDocTreeFileNode, zDocTreeNode };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interactive-inc/docs-client",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "type": "module",
   "scripts": {
     "check": "tsgo --noEmit",
@@ -24,8 +24,9 @@
     ".": "./build/index.js",
     "./models": "./build/models.js",
     "./file-system": "./build/file-system.js",
-    "./file-system-mock": "./build/file-system-mock.js",
     "./file-system-json": "./build/file-system-json.js",
+    "./file-system-mock": "./build/file-system-mock.js",
+    "./file-system-node": "./build/file-system-node.js",
     "./file-system-octokit": "./build/file-system-octokit.js"
   }
 }

package/tmp/docs-studio/files/a.md

@@ -0,0 +1,9 @@
+---
+feature:
+  - feature-1
+priority: high
+---
+
+# File A
+
+This is file A.

package/tmp/docs-studio/pages/delete-document.md

@@ -0,0 +1,7 @@
+---
+is-done: false
+---
+
+# Delete Document
+
+Feature to delete documents.

package/tmp/docs-studio/pages/document-editor.md

@@ -0,0 +1,9 @@
+---
+features:
+  - edit-document-content
+  - delete-document
+---
+
+# Document Editor
+
+This is the document editor page.

package/tmp/docs-studio/pages/edit-document-content.md

@@ -0,0 +1,7 @@
+---
+is-done: true
+---
+
+# Edit Document Content
+
+Feature to edit document content.

package/tmp/docs-studio/pages/index.md

@@ -0,0 +1,14 @@
+---
+icon: 📄
+schema:
+  features:
+    type: multi-relation
+    required: true
+    title: null
+    description: null
+    path: docs-studio/pages
+---
+
+# Pages
+
+All pages in the documentation.