@haruhimemoe/next-kit 0.5.0 → 0.6.0

package/dist/docs/registry.js

@@ -0,0 +1,102 @@
+/**
+ * @file src/docs/registry.ts
+ * @desc The content registry every haruhime.moe site builds its docs, guides and legal pages
+ *       from: a frozen list of sections, the entry shape each page fills in, the app-made extra
+ *       entries a section's nav and search also carry (like bb's tag pages), and the validation
+ *       that catches a bad slug, a duplicate, a made-up date or a blank title at build time
+ *       instead of at a 404. Pure: no node: imports, so it runs anywhere.
+ * @author David @dvhsh (https://dvh.sh)
+ * @created Sun Oct 4, 2026
+ * @modified Sun Oct 4, 2026
+ */
+/** A slug is lowercase words separated by single hyphens, like "make-a-pack". */
+const SLUG_PATTERN = /^[a-z0-9]+(?:-[a-z0-9]+)*$/;
+/** A date is YYYY-MM-DD and a real calendar day. */
+const DATE_PATTERN = /^\d{4}-\d{2}-\d{2}$/;
+/** Every content section a haruhime.moe site can have, in the order it's shown. */
+export const CONTENT_SECTIONS = ["docs", "guides", "legal"];
+/** The nav label for each section. */
+export const SECTION_LABELS = {
+    docs: "Docs",
+    guides: "Guides",
+    legal: "Legal",
+};
+const assertEntries = (section, entries) => {
+    const seen = new Set();
+    for (const entry of entries) {
+        if (!SLUG_PATTERN.test(entry.slug))
+            throw new Error(`docs: bad slug "${entry.slug}" in ${section}`);
+        if (seen.has(entry.slug))
+            throw new Error(`docs: duplicate slug "${entry.slug}" in ${section}`);
+        seen.add(entry.slug);
+        if (!DATE_PATTERN.test(entry.lastUpdated) || Number.isNaN(Date.parse(entry.lastUpdated)))
+            throw new Error(`docs: bad lastUpdated "${entry.lastUpdated}" in ${section} "${entry.slug}"`);
+        if (!entry.title.trim())
+            throw new Error(`docs: blank title in ${section} "${entry.slug}"`);
+    }
+};
+const assertExtras = (section, extras) => {
+    const seen = new Set();
+    for (const extra of extras) {
+        if (!extra.href.startsWith("/"))
+            throw new Error(`docs: extra href "${extra.href}" must start with "/" in ${section}`);
+        if (seen.has(extra.href))
+            throw new Error(`docs: duplicate extra href "${extra.href}" in ${section}`);
+        seen.add(extra.href);
+        if (!extra.title.trim())
+            throw new Error(`docs: blank title for extra "${extra.href}" in ${section}`);
+    }
+};
+/**
+ * @function defineContent
+ * @param input {ContentInput} each section's entries, and the app-made extras under `extra`
+ * @returns {Content} every section filled in (empty arrays for the ones left out), and
+ *   `sections` listing only the non-empty ones, in `CONTENT_SECTIONS` order
+ * @throws {Error} naming the section and slug or extra href, for a bad slug, a duplicate slug,
+ *   a duplicate extra href, a `lastUpdated` that isn't a real `YYYY-MM-DD` date, or a blank title
+ */
+export const defineContent = (input) => {
+    const entries = {};
+    const extra = {};
+    const sections = [];
+    for (const section of CONTENT_SECTIONS) {
+        const sectionEntries = input[section] ?? [];
+        const sectionExtras = input.extra?.[section] ?? [];
+        assertEntries(section, sectionEntries);
+        assertExtras(section, sectionExtras);
+        entries[section] = sectionEntries;
+        extra[section] = sectionExtras;
+        if (sectionEntries.length > 0 || sectionExtras.length > 0)
+            sections.push(section);
+    }
+    return { sections, entries, extra };
+};
+/**
+ * @function contentPath
+ * @param section {ContentSection} the section the page lives under
+ * @param slug {string} the entry's slug
+ * @returns {string} the page's path, like "/guides/make-a-pack"
+ */
+export const contentPath = (section, slug) => `/${section}/${slug}`;
+/**
+ * @function markdownPath
+ * @param section {ContentSection} the section the page lives under
+ * @param slug {string} the entry's slug
+ * @returns {string} the page's raw markdown path, like "/guides/make-a-pack.md"
+ */
+export const markdownPath = (section, slug) => `${contentPath(section, slug)}.md`;
+/**
+ * @function findEntry
+ * @param content {Content} a registry from `defineContent`
+ * @param section {ContentSection} the section to search
+ * @param slug {string} the entry's slug
+ * @returns {ContentEntry | undefined} the matching entry, or undefined
+ */
+export const findEntry = (content, section, slug) => content.entries[section].find((entry) => entry.slug === slug);
+/**
+ * @function contentParams
+ * @param content {Content} a registry from `defineContent`
+ * @param section {ContentSection} the section to list
+ * @returns {{ slug: string }[]} one param per entry, for a dynamic route's `generateStaticParams`
+ */
+export const contentParams = (content, section) => content.entries[section].map((entry) => ({ slug: entry.slug }));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@haruhimemoe/next-kit",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "The Next.js plumbing the haruhime.moe tools share: JSON route helpers, rate limits and budgets in MongoDB, bearer machine auth, zod env parsing, a connect-once MongoDB client with safe index builds, better-auth with osu! sign-in, the signed-in marker and account store for the browser, SEO: metadata, robots.txt, sitemaps, JSON-LD and llms.txt, and per-app API keys and the /api/v1 guard.",
   "keywords": [
     "nextjs",
@@ -62,6 +62,14 @@
       "types": "./dist/api-keys/index.d.ts",
       "default": "./dist/api-keys/index.js"
     },
+    "./docs": {
+      "types": "./dist/docs/index.d.ts",
+      "default": "./dist/docs/index.js"
+    },
+    "./docs/files": {
+      "types": "./dist/docs/files/index.d.ts",
+      "default": "./dist/docs/files/index.js"
+    },
     "./package.json": "./package.json"
   },
   "files": [
@@ -92,7 +100,7 @@
   },
   "peerDependencies": {
     "@haruhimemoe/osu": "^0.2.0 || ^0.3.0 || ^0.4.0",
-    "@haruhimemoe/ui": "^0.5.0 || ^0.6.0 || ^0.7.0 || ^0.8.0 || ^0.9.0",
+    "@haruhimemoe/ui": "^0.5.0 || ^0.6.0 || ^0.7.0 || ^0.8.0 || ^0.9.0 || ^0.10.0",
     "better-auth": "^1.7.5",
     "mongodb": "^7.6.0",
     "mongodb-memory-server": "^11.3.0",