@interactive-inc/docs-client 0.0.18 → 1.0.1

package/build/index.d.ts

@@ -1715,7 +1715,7 @@ declare class DocClient {
 /**
  * In-memory file system for testing
  */
-declare class DocFileSystemDebug extends DocFileSystem {
+declare class DocFileSystemMock extends DocFileSystem {
     private files;
     private readonly _pathSystem;
     constructor(props: {
@@ -1726,13 +1726,17 @@ declare class DocFileSystemDebug extends DocFileSystem {
      * PathSystem accessor (for testing)
      */
     getPathSystem(): DocPathSystem;
+    /**
+     * Create instance (mock data is automatically loaded)
+     */
+    static create(basePath?: string): DocFileSystemMock;
     /**
      * Factory method for testing
      */
     static createWithFiles(props: {
         basePath?: string;
         fileContents?: Record<string, string>;
-    }): DocFileSystemDebug;
+    }): DocFileSystemMock;
     readFile(filePath: string): Promise<string | null>;
     writeFile(filePath: string, content: string): Promise<void>;
     deleteFile(filePath: string): Promise<Error | null>;
@@ -1791,6 +1795,27 @@ declare class DocFileSystemDebug extends DocFileSystem {
     setupTestFiles(files: Record<string, string>): void;
 }
 
+/**
+ * Mock path system for testing
+ */
+declare class DocPathSystemMock extends DocPathSystem {
+    private readonly _separator;
+    constructor(separator?: string);
+    join(...paths: string[]): string;
+    basename(path: string, ext?: string): string;
+    dirname(path: string): string;
+    extname(path: string): string;
+    relative(from: string, to: string): string;
+    resolve(...paths: string[]): string;
+    normalize(path: string): string;
+    isAbsolute(path: string): boolean;
+    get sep(): string;
+    /**
+     * Set custom separator for testing
+     */
+    static createWithSeparator(separator: string): DocPathSystemMock;
+}
+
 /**
  * Schema builder
  * Build schemas in a chain style
@@ -1939,4 +1964,4 @@ declare const docCustomSchemaField: {
     };
 };
 
-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, type DocDirectory, DocDirectoryReference, type DocFieldTypeLiteral, type DocFile, type DocFileEntity, type DocFileIndex, type DocFileIndexContent, DocFileIndexEntity, type DocFileIndexMeta, DocFileIndexReference, type DocFileIndexSchema, type DocFileIndexSchemaField, type DocFileMd, type DocFileMdContent, DocFileMdEntity, type DocFileMdMeta, DocFileMdReference, type DocFilePath, DocFileRelationReference, DocFileSystem, DocFileSystemDebug, 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, type DocRelation, type DocRelationField, type DocRelationFile, 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, type DocTreeFileNode, type DocTreeNode, type Equals, type ExtractFieldType, type ExtractIndexFieldType, type ExtractRequired, type FieldValueType, type GetIndexFieldType, type GetIndexFieldValueType, type GetValueType, type InferDocFileMd, type InferReference, type MultiRelationKeys, type OptionalKeys, type RecordKey, type RelationKeys, type RequiredKeys, type SchemaToValueType, assertType, defaultTestConfig, defineSchema, docCustomSchemaField, expectType, zDocClientConfig, zDocFileIndexSchemaField, 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 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, type DocDirectory, DocDirectoryReference, type DocFieldTypeLiteral, type DocFile, type DocFileEntity, type DocFileIndex, type DocFileIndexContent, DocFileIndexEntity, type DocFileIndexMeta, DocFileIndexReference, type DocFileIndexSchema, type DocFileIndexSchemaField, type DocFileMd, type DocFileMdContent, DocFileMdEntity, type DocFileMdMeta, DocFileMdReference, type DocFilePath, 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, type DocRelationFile, 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, type DocTreeFileNode, type DocTreeNode, type Equals, type ExtractFieldType, type ExtractIndexFieldType, type ExtractRequired, type FieldValueType, type GetIndexFieldType, type GetIndexFieldValueType, type GetValueType, type InferDocFileMd, type InferReference, type MultiRelationKeys, type OptionalKeys, type RecordKey, type RelationKeys, type RequiredKeys, type SchemaToValueType, assertType, defaultTestConfig, defineSchema, docCustomSchemaField, expectType, zDocClientConfig, zDocFileIndexSchemaField, 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/build/index.js

@@ -5062,13 +5062,46 @@ var DocFileSystem = class {
   }
 };
 
-// lib/doc-file-system-debug.ts
-var DocFileSystemDebug = class _DocFileSystemDebug extends DocFileSystem {
+// lib/doc-file-system-mock.ts
+var mockDirectoryData = {
+  "docs/index.md": `---
+icon: \u{1F4DA}
+---
+
+# Documentation
+
+Welcome to the documentation!`,
+  "docs/guide/index.md": `---
+icon: \u{1F4D6}
+---
+
+# Guide
+
+This is a guide.`,
+  "docs/guide/getting-started.md": `# Getting Started
+
+Let's get started!`,
+  "docs/guide/advanced.md": `# Advanced
+
+Advanced topics here.`,
+  "docs/api/index.md": `---
+icon: \u{1F527}
+---
+
+# API
+
+API documentation.`,
+  "docs/api/reference.md": `# API Reference
+
+Complete API reference.`
+};
+var DocFileSystemMock = class _DocFileSystemMock extends DocFileSystem {
   files = /* @__PURE__ */ new Map();
   _pathSystem;
   constructor(props) {
     super(props);
     this._pathSystem = props.pathSystem;
+    this.setupTestFiles(mockDirectoryData);
     Object.freeze(this);
   }
   /**
@@ -5077,13 +5110,20 @@ var DocFileSystemDebug = class _DocFileSystemDebug extends DocFileSystem {
   getPathSystem() {
     return this._pathSystem;
   }
+  /**
+   * Create instance (mock data is automatically loaded)
+   */
+  static create(basePath = "/test") {
+    const pathSystem = new DocPathSystem();
+    return new _DocFileSystemMock({ basePath, pathSystem });
+  }
   /**
    * Factory method for testing
    */
   static createWithFiles(props) {
     const pathSystem = new DocPathSystem();
     const basePath = props.basePath ?? "/test";
-    const fileSystem = new _DocFileSystemDebug({ basePath, pathSystem });
+    const fileSystem = new _DocFileSystemMock({ basePath, pathSystem });
     if (props.fileContents) {
       const now = /* @__PURE__ */ new Date();
       for (const [path, content] of Object.entries(props.fileContents)) {
@@ -5243,7 +5283,7 @@ var DocFileSystemDebug = class _DocFileSystemDebug extends DocFileSystem {
    * Get list of entries in directory
    */
   async readDirectoryFileNames(directoryPath = "") {
-    const normalizedDir = directoryPath === "" ? "docs" : directoryPath.startsWith("docs/") ? directoryPath : `docs/${directoryPath}`;
+    const normalizedDir = directoryPath === "" ? "docs" : directoryPath === "docs" ? "docs" : directoryPath.startsWith("docs/") ? directoryPath : `docs/${directoryPath}`;
     const dirPath = normalizedDir.endsWith("/") ? normalizedDir : `${normalizedDir}/`;
     const entries = /* @__PURE__ */ new Set();
     for (const path of this.files.keys()) {
@@ -5320,6 +5360,109 @@ var DocFileSystemDebug = class _DocFileSystemDebug extends DocFileSystem {
   }
 };
 
+// lib/doc-path-system-mock.ts
+var DocPathSystemMock = class _DocPathSystemMock extends DocPathSystem {
+  _separator;
+  constructor(separator = "/") {
+    super();
+    this._separator = separator;
+    Object.freeze(this);
+  }
+  join(...paths) {
+    return paths.filter((path) => path !== "").join(this._separator).replace(new RegExp(`${this._separator}+`, "g"), this._separator);
+  }
+  basename(path, ext) {
+    const normalizedPath = path.replace(/\\/g, "/");
+    const lastSlashIndex = normalizedPath.lastIndexOf("/");
+    let base = lastSlashIndex === -1 ? normalizedPath : normalizedPath.slice(lastSlashIndex + 1);
+    if (ext && base.endsWith(ext)) {
+      base = base.slice(0, -ext.length);
+    }
+    return base;
+  }
+  dirname(path) {
+    const normalizedPath = path.replace(/\\/g, "/");
+    const lastSlashIndex = normalizedPath.lastIndexOf("/");
+    if (lastSlashIndex === -1) {
+      return ".";
+    }
+    if (lastSlashIndex === 0) {
+      return "/";
+    }
+    return normalizedPath.slice(0, lastSlashIndex);
+  }
+  extname(path) {
+    const base = this.basename(path);
+    const lastDotIndex = base.lastIndexOf(".");
+    if (lastDotIndex === -1 || lastDotIndex === 0) {
+      return "";
+    }
+    return base.slice(lastDotIndex);
+  }
+  relative(from, to) {
+    const fromParts = from.split("/").filter(Boolean);
+    const toParts = to.split("/").filter(Boolean);
+    let commonLength = 0;
+    for (let i = 0; i < Math.min(fromParts.length, toParts.length); i++) {
+      if (fromParts[i] === toParts[i]) {
+        commonLength++;
+      } else {
+        break;
+      }
+    }
+    const upLevels = fromParts.length - commonLength;
+    const downParts = toParts.slice(commonLength);
+    const result = Array(upLevels).fill("..").concat(downParts);
+    return result.length === 0 ? "." : result.join("/");
+  }
+  resolve(...paths) {
+    let resolved = "";
+    let isAbsolute = false;
+    for (let i = paths.length - 1; i >= 0 && !isAbsolute; i--) {
+      const path = paths[i];
+      if (path) {
+        resolved = path + (resolved ? `/${resolved}` : "");
+        isAbsolute = path.startsWith("/");
+      }
+    }
+    if (!isAbsolute) {
+      resolved = `/mock-cwd/${resolved}`;
+    }
+    return this.normalize(resolved);
+  }
+  normalize(path) {
+    if (!path) return ".";
+    const isAbsolute = path.startsWith("/");
+    const parts = path.split("/").filter(Boolean);
+    const normalizedParts = [];
+    for (const part of parts) {
+      if (part === "..") {
+        if (normalizedParts.length > 0 && normalizedParts[normalizedParts.length - 1] !== "..") {
+          normalizedParts.pop();
+        } else if (!isAbsolute) {
+          normalizedParts.push("..");
+        }
+      } else if (part !== ".") {
+        normalizedParts.push(part);
+      }
+    }
+    const result = (isAbsolute ? "/" : "") + normalizedParts.join("/");
+    return result || (isAbsolute ? "/" : ".");
+  }
+  isAbsolute(path) {
+    return path.startsWith("/");
+  }
+  get sep() {
+    return this._separator;
+  }
+  /**
+   * Set custom separator for testing
+   */
+  static createWithSeparator(separator) {
+    return new _DocPathSystemMock(separator);
+  }
+};
+
 // lib/doc-schema-builder.ts
 var DocSchemaBuilder = class _DocSchemaBuilder {
   constructor(schema = {}) {
@@ -5489,12 +5632,13 @@ export {
   DocFileMdReference,
   DocFileRelationReference,
   DocFileSystem,
-  DocFileSystemDebug,
+  DocFileSystemMock,
   DocFileTreeSystem,
   DocFileUnknownEntity,
   DocFileUnknownReference,
   DocMarkdownSystem,
   DocPathSystem,
+  DocPathSystemMock,
   DocSchemaBuilder,
   assertType,
   defaultTestConfig,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interactive-inc/docs-client",
-  "version": "0.0.18",
+  "version": "1.0.1",
   "type": "module",
   "scripts": {
     "check": "tsgo --noEmit",
@@ -8,8 +8,10 @@
     "deploy": "bun run build && npm publish"
   },
   "dependencies": {
-    "yaml": "^2.8.0",
-    "zod": "^4.0.10"
+    "yaml": "^2.0.0"
+  },
+  "peerDependencies": {
+    "zod": "^4.0.0"
   },
   "publishConfig": {
     "access": "public"

package/debug/debug.ts

@@ -1,62 +0,0 @@
-import { DocClient } from "@/doc-client"
-import { DocFileSystem } from "@/doc-file-system"
-import { DocSchemaBuilder } from "@/doc-schema-builder"
-import { defineSchema, docCustomSchemaField } from "@/utils"
-
-const client = new DocClient({
-  fileSystem: new DocFileSystem({ basePath: "../../docs" }),
-})
-
-// Method 1: Using defineSchema (recommended)
-const pageSchema = defineSchema({
-  features: docCustomSchemaField.multiRelation(true),
-})
-
-const pagesRef = client.directory("docs-studio").directory("pages", pageSchema)
-
-const mdFileRef = pagesRef.file("document-editor.md")
-
-const mdFile = await mdFileRef.read()
-
-if (mdFile instanceof Error) {
-  throw mdFile
-}
-
-const _features = mdFile.content.meta().field("features")
-
-mdFile.withContent(
-  mdFile.content.withMetaProperty("features", [
-    "edit-document-content",
-    "delete-document",
-    "foo",
-  ]),
-)
-
-// Method 2: Using field helpers
-const featureSchema = defineSchema({
-  "is-done": docCustomSchemaField.boolean(true),
-})
-
-const relations = await mdFileRef.relations("features", featureSchema)
-
-const file = await relations[0].read()
-
-console.log("relations", file)
-
-// Method 3: Using SchemaBuilder
-const fooSchema = new DocSchemaBuilder()
-  .multiRelation("feature", true)
-  .text("priority", false)
-  .build()
-
-const fooRef = client.directory("docs-studio/files", fooSchema)
-
-const aaa = await fooRef.mdFile("a")
-
-const fooFile = await aaa.read()
-
-if (fooFile instanceof Error) {
-  throw fooFile
-}
-
-fooFile.content.meta().field("feature")

package/tsup.config.ts

@@ -1,10 +0,0 @@
-import { defineConfig } from "tsup"
-
-export default defineConfig({
-  entry: ["lib/index.ts", "lib/models.ts"],
-  outDir: "build",
-  format: ["esm"],
-  clean: true,
-  dts: true,
-  splitting: false,
-})