@farming-labs/svelte 0.0.2-beta.13 → 0.0.2-beta.15

package/dist/content.d.ts

@@ -5,6 +5,7 @@
  * extracts frontmatter, and builds a navigation tree compatible
  * with @farming-labs/docs DocsConfig.
  */
+import type { OrderingItem } from "@farming-labs/docs";
 export interface PageNode {
     type: "page";
     name: string;
@@ -44,7 +45,7 @@ export declare function loadDocsContent(contentDir: string, entry?: string): Con
 /**
  * Build a navigation tree from a content directory.
  */
-export declare function loadDocsNavTree(contentDir: string, entry?: string): NavTree;
+export declare function loadDocsNavTree(contentDir: string, entry?: string, ordering?: "alphabetical" | "numeric" | OrderingItem[]): NavTree;
 /**
  * Flatten a navigation tree into an ordered list of pages.
  * Useful for computing previous/next page links.

package/dist/content.js

@@ -58,7 +58,7 @@ export function loadDocsContent(contentDir, entry = "docs") {
 /**
  * Build a navigation tree from a content directory.
  */
-export function loadDocsNavTree(contentDir, entry = "docs") {
+export function loadDocsNavTree(contentDir, entry = "docs", ordering) {
     const absDir = path.resolve(contentDir);
     const children = [];
     const indexPath = findIndex(absDir);
@@ -71,42 +71,87 @@ export function loadDocsNavTree(contentDir, entry = "docs") {
             icon: data.icon,
         });
     }
-    children.push(...scanDir(absDir, [], entry));
+    const rootSlugOrder = Array.isArray(ordering) ? ordering : undefined;
+    children.push(...scanDir(absDir, [], entry, ordering, rootSlugOrder));
     return { name: "Docs", children };
 }
-function scanDir(dir, slugParts, entry) {
+function buildNavNode(dir, name, slugParts, entry, ordering, childSlugOrder) {
+    const full = path.join(dir, name);
+    if (!fs.statSync(full).isDirectory())
+        return null;
+    const indexPath = findIndex(full);
+    if (!indexPath)
+        return null;
+    const { data } = matter(fs.readFileSync(indexPath, "utf-8"));
+    const slug = [...slugParts, name];
+    const url = `/${entry}/${slug.join("/")}`;
+    const displayName = data.title ?? name.replace(/-/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
+    const icon = data.icon;
+    const childDirs = fs.readdirSync(full).filter((n) => {
+        const p = path.join(full, n);
+        return fs.statSync(p).isDirectory() && findIndex(p) !== null;
+    });
+    if (childDirs.length > 0) {
+        return {
+            type: "folder",
+            name: displayName,
+            icon,
+            index: { type: "page", name: displayName, url, icon },
+            children: scanDir(full, slug, entry, ordering, childSlugOrder),
+        };
+    }
+    return { type: "page", name: displayName, url, icon };
+}
+function scanDir(dir, slugParts, entry, ordering, slugOrder) {
     if (!fs.existsSync(dir))
         return [];
-    const nodes = [];
     const entries = fs.readdirSync(dir).sort();
-    for (const name of entries) {
-        const full = path.join(dir, name);
-        if (!fs.statSync(full).isDirectory())
-            continue;
-        const indexPath = findIndex(full);
-        if (!indexPath)
-            continue;
-        const { data } = matter(fs.readFileSync(indexPath, "utf-8"));
-        const slug = [...slugParts, name];
-        const url = `/${entry}/${slug.join("/")}`;
-        const displayName = data.title ?? name.replace(/-/g, " ").replace(/\b\w/g, (c) => c.toUpperCase());
-        const icon = data.icon;
-        const childDirs = fs.readdirSync(full).filter((n) => {
-            const p = path.join(full, n);
-            return fs.statSync(p).isDirectory() && findIndex(p) !== null;
-        });
-        if (childDirs.length > 0) {
-            nodes.push({
-                type: "folder",
-                name: displayName,
-                icon,
-                index: { type: "page", name: displayName, url, icon },
-                children: scanDir(full, slug, entry),
-            });
+    if (slugOrder) {
+        const nodes = [];
+        const slugMap = new Set(slugOrder.map((i) => i.slug));
+        for (const item of slugOrder) {
+            if (!entries.includes(item.slug))
+                continue;
+            const node = buildNavNode(dir, item.slug, slugParts, entry, ordering, item.children);
+            if (node)
+                nodes.push(node);
+        }
+        for (const name of entries) {
+            if (slugMap.has(name))
+                continue;
+            const node = buildNavNode(dir, name, slugParts, entry, ordering);
+            if (node)
+                nodes.push(node);
         }
-        else {
-            nodes.push({ type: "page", name: displayName, url, icon });
+        return nodes;
+    }
+    if (ordering === "numeric") {
+        const nodes = [];
+        for (const name of entries) {
+            const full = path.join(dir, name);
+            if (!fs.statSync(full).isDirectory())
+                continue;
+            const indexPath = findIndex(full);
+            if (!indexPath)
+                continue;
+            const { data } = matter(fs.readFileSync(indexPath, "utf-8"));
+            const order = typeof data.order === "number" ? data.order : Infinity;
+            const node = buildNavNode(dir, name, slugParts, entry, ordering);
+            if (node)
+                nodes.push({ order, node });
         }
+        nodes.sort((a, b) => {
+            if (a.order === b.order)
+                return 0;
+            return a.order - b.order;
+        });
+        return nodes.map((n) => n.node);
+    }
+    const nodes = [];
+    for (const name of entries) {
+        const node = buildNavNode(dir, name, slugParts, entry, ordering);
+        if (node)
+            nodes.push(node);
     }
     return nodes;
 }

package/dist/server.js

@@ -49,7 +49,7 @@ function stripMarkdownText(content) {
         .replace(/\n{3,}/g, "\n\n")
         .trim();
 }
-function navTreeFromMap(contentMap, dirPrefix, entry) {
+function navTreeFromMap(contentMap, dirPrefix, entry, ordering) {
     const dirs = [];
     for (const key of Object.keys(contentMap)) {
         if (!key.startsWith(dirPrefix))
@@ -74,8 +74,10 @@ function navTreeFromMap(contentMap, dirPrefix, entry) {
             title: data.title ?? fallbackTitle,
             url,
             icon: data.icon,
+            order: typeof data.order === "number" ? data.order : Infinity,
         });
     }
+    // Default sort: depth first, then by ordering strategy
     dirs.sort((a, b) => {
         if (a.parts.length !== b.parts.length)
             return a.parts.length - b.parts.length;
@@ -91,8 +93,19 @@ function navTreeFromMap(contentMap, dirPrefix, entry) {
             icon: rootInfo.icon,
         });
     }
+    function findSlugOrder(parentParts) {
+        if (!Array.isArray(ordering))
+            return undefined;
+        let items = ordering;
+        for (const part of parentParts) {
+            const found = items.find((i) => i.slug === part);
+            if (!found?.children)
+                return undefined;
+            items = found.children;
+        }
+        return items;
+    }
     function buildLevel(parentParts) {
-        const nodes = [];
         const depth = parentParts.length;
         const directChildren = dirs.filter((d) => {
             if (d.parts.length !== depth + 1)
@@ -103,6 +116,49 @@ function navTreeFromMap(contentMap, dirPrefix, entry) {
             }
             return true;
         });
+        const slugOrder = findSlugOrder(parentParts);
+        if (slugOrder) {
+            const slugMap = new Set(slugOrder.map((i) => i.slug));
+            const ordered = [];
+            for (const item of slugOrder) {
+                const match = directChildren.find((d) => d.parts[depth] === item.slug);
+                if (match)
+                    ordered.push(match);
+            }
+            for (const child of directChildren) {
+                if (!slugMap.has(child.parts[depth]))
+                    ordered.push(child);
+            }
+            const nodes = [];
+            for (const child of ordered) {
+                const hasGrandChildren = dirs.some((d) => {
+                    if (d.parts.length <= child.parts.length)
+                        return false;
+                    return child.parts.every((p, i) => d.parts[i] === p);
+                });
+                if (hasGrandChildren) {
+                    nodes.push({
+                        type: "folder",
+                        name: child.title,
+                        icon: child.icon,
+                        index: { type: "page", name: child.title, url: child.url, icon: child.icon },
+                        children: buildLevel(child.parts),
+                    });
+                }
+                else {
+                    nodes.push({ type: "page", name: child.title, url: child.url, icon: child.icon });
+                }
+            }
+            return nodes;
+        }
+        if (ordering === "numeric") {
+            directChildren.sort((a, b) => {
+                if (a.order === b.order)
+                    return 0;
+                return a.order - b.order;
+            });
+        }
+        const nodes = [];
         for (const child of directChildren) {
             const hasGrandChildren = dirs.some((d) => {
                 if (d.parts.length <= child.parts.length)
@@ -206,6 +262,7 @@ export function createDocsServer(config = {}) {
     const preloaded = config._preloadedContent;
     const contentDirRel = config.contentDir ?? entry;
     const dirPrefix = `/${contentDirRel}/`;
+    const ordering = config.ordering;
     const aiConfig = config.ai ?? {};
     // Allow top-level apiKey as a shorthand
     if (config.apiKey && !aiConfig.apiKey) {
@@ -214,8 +271,8 @@ export function createDocsServer(config = {}) {
     // ─── Unified load (tree + page content in one call) ────────
     async function load(event) {
         const tree = preloaded
-            ? navTreeFromMap(preloaded, dirPrefix, entry)
-            : loadDocsNavTree(contentDir, entry);
+            ? navTreeFromMap(preloaded, dirPrefix, entry, ordering)
+            : loadDocsNavTree(contentDir, entry, ordering);
         const flatPages = flattenNavTree(tree);
         const urlPrefix = new RegExp(`^/${entry}/?`);
         const slug = event.url.pathname.replace(urlPrefix, "");
@@ -379,6 +436,7 @@ export function createDocsServer(config = {}) {
             }), { status: 404, headers: { "Content-Type": "application/json" } });
         }
         const resolvedKey = aiConfig.apiKey ??
+            (typeof import.meta !== "undefined" ? import.meta.env?.OPENAI_API_KEY : undefined) ??
             (typeof process !== "undefined" ? process.env?.OPENAI_API_KEY : undefined);
         if (!resolvedKey) {
             return new Response(JSON.stringify({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/svelte",
-  "version": "0.0.2-beta.13",
+  "version": "0.0.2-beta.15",
   "description": "SvelteKit adapter for @farming-labs/docs — content loading and navigation utilities",
   "type": "module",
   "main": "./dist/index.js",
@@ -50,7 +50,7 @@
   "devDependencies": {
     "@types/node": "^22.10.0",
     "typescript": "^5.9.3",
-    "@farming-labs/docs": "0.0.2-beta.13"
+    "@farming-labs/docs": "0.0.2-beta.15"
   },
   "peerDependencies": {
     "@farming-labs/docs": "*"