@open-agent-toolkit/docs-config 0.3.25 → 0.3.26

package/README.md

@@ -30,10 +30,16 @@ export default createDocsConfig({
 import { createSourceConfig } from '@open-agent-toolkit/docs-config';
 import { defineConfig, defineDocs } from 'fumadocs-mdx/config';
 
-const sourceConfig = createSourceConfig();
+// Paths resolve from the app working directory, including bundled source configs.
+const sourceConfig = createSourceConfig({
+  oatConfigFile: '../../.oat/config.json',
+  appRoot: '.',
+});
 
 export const docs = defineDocs({
   dir: sourceConfig.contentDir,
+  docs: sourceConfig.docs,
+  meta: sourceConfig.meta,
 });
 
 export default defineConfig({
@@ -43,6 +49,10 @@ export default defineConfig({
 });
 ```
 
+The `docs` and `meta` options apply shared `documentation.nonReaderPaths` only when the explicit repo config's documentation root matches this app. Patterns follow OAT's bounded content-root-relative grammar: `*` within a segment, whole-segment `**` across directories, trailing `/` for directories, all other characters literal. Excluded directories omit descendants and metadata. `documentation.excludes` remains manifest-only. No ancestor config search occurs; scaffolded apps receive their resolved relative config path.
+
+The metadata schema preserves Fumadocs fields and accepts boolean roots and nonempty trimmed string inputs. String inputs normalize to `true` for the pinned generated collection types; authored metadata files remain unchanged. Booleans, including `false`, retain their values. Use both source options so collection validation and rendering agree with navigation. The scaffold pins MkDocs 1.4.2 separately; that version has no configurable rendering exclusion, so its non-readers leave nav/manifest but still render as routes.
+
 ## Exports
 
 - `createDocsConfig`

package/dist/reader-paths.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Adapt OAT's bounded exclusion grammar to collection globs. Only `*` and a
+ * whole-segment `**` are operators; every other glob metacharacter is literal.
+ * Negative patterns cover descendants too because matching a directory prunes it.
+ */
+export declare function collectionFiles(patterns: readonly string[], extensions: string[]): string[];
+//# sourceMappingURL=reader-paths.d.ts.map

package/dist/reader-paths.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"reader-paths.d.ts","sourceRoot":"","sources":["../src/reader-paths.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,eAAe,CAC7B,QAAQ,EAAE,SAAS,MAAM,EAAE,EAC3B,UAAU,EAAE,MAAM,EAAE,GACnB,MAAM,EAAE,CA8BV"}

package/dist/reader-paths.js

@@ -0,0 +1,36 @@
+/**
+ * Adapt OAT's bounded exclusion grammar to collection globs. Only `*` and a
+ * whole-segment `**` are operators; every other glob metacharacter is literal.
+ * Negative patterns cover descendants too because matching a directory prunes it.
+ */
+export function collectionFiles(patterns, extensions) {
+    const files = [`**/*.{${extensions.join(',')}}`];
+    for (const raw of patterns) {
+        const trimmed = raw.trim();
+        const directoryOnly = trimmed.endsWith('/');
+        const path = trimmed
+            .replace(/\/+$/, '')
+            .replace(/^\.\//, '')
+            .replace(/^\/+/, '');
+        if (!path)
+            continue;
+        const segments = path.split('/');
+        const glob = segments
+            .map((segment) => segment === '**'
+            ? '**'
+            : segment.replace(/\*+/g, '*').replace(/[?[\]{}()!+@|\\]/g, '\\$&'))
+            .join('/');
+        if (directoryOnly) {
+            // A globstar may consume zero segments, but a pruned directory must
+            // consume at least one, followed by an actual descendant file.
+            const directoryGlob = segments.every((segment) => segment === '**')
+                ? '*'
+                : glob;
+            files.push(`!${directoryGlob}/**/*`);
+        }
+        else {
+            files.push(`!${glob}`, `!${glob}/**`);
+        }
+    }
+    return files;
+}

package/dist/source-config.d.ts

@@ -2,11 +2,34 @@ import type { Root } from 'mdast';
 import type { Plugin } from 'unified';
 import { type SearchConfig } from './search-config.js';
 type RemarkPlugin = Plugin<any[], Root>;
+declare const docsMetaSchema: import("zod").ZodObject<{
+    title: import("zod").ZodOptional<import("zod").ZodString>;
+    pages: import("zod").ZodOptional<import("zod").ZodArray<import("zod").ZodString>>;
+    pagesIndex: import("zod").ZodOptional<import("zod").ZodString>;
+    description: import("zod").ZodOptional<import("zod").ZodString>;
+    defaultOpen: import("zod").ZodOptional<import("zod").ZodBoolean>;
+    collapsible: import("zod").ZodOptional<import("zod").ZodBoolean>;
+    icon: import("zod").ZodOptional<import("zod").ZodString>;
+    root: import("zod").ZodOptional<import("zod").ZodUnion<[import("zod").ZodBoolean, import("zod").ZodPipe<import("zod").ZodString, import("zod").ZodTransform<boolean, string>>]>>;
+}, import("zod/v4/core").$strip>;
+export interface SourceConfigOptions {
+    /** Explicit repository .oat/config.json location; no ancestor search. */
+    oatConfigFile?: string | URL;
+    /** The source.config.ts app directory; settings apply only to the matching app. */
+    appRoot?: string | URL;
+}
 export interface SourceConfigResult {
     remarkPlugins: RemarkPlugin[];
     contentDir: string;
     search: SearchConfig;
+    docs: {
+        files: string[];
+    };
+    meta: {
+        files: string[];
+        schema: typeof docsMetaSchema;
+    };
 }
-export declare function createSourceConfig(): SourceConfigResult;
+export declare function createSourceConfig(options?: SourceConfigOptions): SourceConfigResult;
 export {};
 //# sourceMappingURL=source-config.d.ts.map

package/dist/source-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"source-config.d.ts","sourceRoot":"","sources":["../src/source-config.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAEtC,OAAO,EAAsB,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAG3E,KAAK,YAAY,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;AAExC,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;CACtB;AAED,wBAAgB,kBAAkB,IAAI,kBAAkB,CAMvD"}
+{"version":3,"file":"source-config.d.ts","sourceRoot":"","sources":["../src/source-config.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,OAAO,CAAC;AAElC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AAGtC,OAAO,EAAsB,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAG3E,KAAK,YAAY,GAAG,MAAM,CAAC,GAAG,EAAE,EAAE,IAAI,CAAC,CAAC;AAIxC,QAAA,MAAM,cAAc;;;;;;;;;gCAWlB,CAAC;AAEH,MAAM,WAAW,mBAAmB;IAClC,yEAAyE;IACzE,aAAa,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IAC7B,mFAAmF;IACnF,OAAO,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;CACxB;AAED,MAAM,WAAW,kBAAkB;IACjC,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,YAAY,CAAC;IACrB,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;IAC1B,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,EAAE,CAAC;QAAC,MAAM,EAAE,OAAO,cAAc,CAAA;KAAE,CAAC;CAC1D;AAuCD,wBAAgB,kBAAkB,CAChC,OAAO,GAAE,mBAAwB,GAChC,kBAAkB,CAYpB"}

package/dist/source-config.js

@@ -1,10 +1,63 @@
+import { readFileSync } from 'node:fs';
+import { dirname, resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
 import { remarkLinks, remarkMermaid, remarkTabs, } from '@open-agent-toolkit/docs-transforms';
+import { metaSchema } from 'fumadocs-core/source/schema';
 import { remarkAlert } from 'remark-github-blockquote-alert';
+import { collectionFiles } from './reader-paths.js';
 import { createSearchConfig } from './search-config.js';
-export function createSourceConfig() {
+// Accept named-root inputs while keeping output compatible with fumadocs-mdx
+// 14.3.2's generated server.docs conditional and core 16.10.2's MetaData.
+const docsMetaSchema = metaSchema.extend({
+    root: metaSchema.shape.root
+        .unwrap()
+        .or(metaSchema.shape.title
+        .unwrap()
+        .trim()
+        .min(1)
+        .transform(() => true))
+        .optional(),
+});
+function nonReaderPaths(options) {
+    if (!options.oatConfigFile || !options.appRoot)
+        return [];
+    const configFile = options.oatConfigFile instanceof URL
+        ? fileURLToPath(options.oatConfigFile)
+        : resolve(options.oatConfigFile);
+    const appRoot = options.appRoot instanceof URL
+        ? fileURLToPath(options.appRoot)
+        : options.appRoot;
+    let config;
+    try {
+        config = JSON.parse(readFileSync(configFile, 'utf8'));
+    }
+    catch (error) {
+        if (error.code === 'ENOENT')
+            return [];
+        throw error;
+    }
+    const doc = config.documentation;
+    if (typeof doc?.root !== 'string' ||
+        resolve(dirname(dirname(configFile)), doc.root.trim()) !== resolve(appRoot))
+        return [];
+    if (doc.nonReaderPaths === undefined)
+        return [];
+    if (!Array.isArray(doc.nonReaderPaths) ||
+        doc.nonReaderPaths.some((value) => typeof value !== 'string' || !value.trim())) {
+        throw new Error(`Invalid documentation.nonReaderPaths in ${configFile}: expected an array of non-empty strings.`);
+    }
+    return doc.nonReaderPaths;
+}
+export function createSourceConfig(options = {}) {
+    const patterns = nonReaderPaths(options);
     return {
         remarkPlugins: [remarkLinks, remarkTabs, remarkAlert, remarkMermaid],
         contentDir: './docs',
         search: createSearchConfig(),
+        docs: { files: collectionFiles(patterns, ['md', 'mdx']) },
+        meta: {
+            files: collectionFiles(patterns, ['json', 'yaml']),
+            schema: docsMetaSchema,
+        },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-agent-toolkit/docs-config",
-  "version": "0.3.25",
+  "version": "0.3.26",
   "private": false,
   "description": "Configuration factories for OAT documentation sites",
   "homepage": "https://github.com/voxmedia/open-agent-toolkit/tree/main/packages/docs-config",
@@ -33,7 +33,8 @@
     "flexsearch": "^0.8.212",
     "remark-github-blockquote-alert": "^2.0.1",
     "unified": "^11.0.5",
-    "@open-agent-toolkit/docs-transforms": "0.3.25"
+    "zod": "^4.3.6",
+    "@open-agent-toolkit/docs-transforms": "0.3.26"
   },
   "devDependencies": {
     "@types/mdast": "^4.0.4",