@nifrajs/content 5.1.0 → 5.3.0

package/CHANGELOG.md

@@ -0,0 +1,150 @@
+# @nifrajs/content
+
+## 5.3.0
+
+### Patch Changes
+
+- 7d7bbe4: `defineCollection` takes `watch: false` to list and parse its directory once and return that snapshot from every later `all()`. The default still lists the directory and stats every file per call, which costs 3.5 ms per `all()` at 2,000 files; with `watch: false` it costs 0.005 ms. A file deleted and recreated with the same size and modification time is also read again, where a parse cached before the deletion used to be returned.
+
+## 5.2.1
+
+No changes in this release.
+
+## 5.2.0
+
+### Patch Changes
+
+- 9498cf8: The package ships its `CHANGELOG.md`, so the installed package has the notes for every version, as the GitHub release does. Before, the tarball held only the code, `README.md`, `LICENSE` and `package.json`.
+
+## 5.1.0
+
+No changes in this release.
+
+## 5.0.0
+
+### Patch Changes
+
+- 1f81be1: `defineCollection` reads the directory, stats and files with async file IO. It used the synchronous calls inside `all()` and `get()`, which blocked a long-lived server's event loop for the whole read.
+- 5f867e3: `collection.get(slug)` now throws for an entry whose frontmatter fails to parse or validate, as `all()` does, and returns `null` only when no file exists for the slug. A broken entry used to look like a missing one, so a page answered 404 instead of surfacing the error.
+
+## 4.0.2
+
+## 4.0.1
+
+## 4.0.0
+
+## 3.5.0
+
+## 3.4.0
+
+## 3.3.0
+
+## 3.2.0
+
+### Patch Changes
+
+- f34a050: Record the pending source changes for these packages in their release notes so fixed-version publishing does not omit their changelog entries.
+
+## 3.1.0
+
+## 3.0.0
+
+### Patch Changes
+
+- 6e43c15: A failed boundary load no longer publishes the thrown error's own message. Boundary states are serialized into the document, so a driver or fetch failure was putting hosts, credentials, and query text on the page for every visitor who loaded it while the dependency was down. The client slot is now always `Boundary failed`, an `Error` subclass name is withheld for the same reason it names the failing internal library, and the real error is reported to the server console - the split already used for a rejected deferred value. A boundary that wants to show the user something specific catches its own failure inside `load` and returns that as data.
+
+  Opt-in outbound WebSocket validation (`validateSend`) contains a rejected diagnostic instead of recursing. An `error()` handler that answers a dropped frame by sending one of its own re-entered the reporter through the two paths that bypassed its guard - schema rejection and an async validator - and unwound only when the stack was exhausted, silently. Every failure path now reports through the guard.
+
+  A content index cursor is checked for the query that issued it separately from running off the end: a cursor from a different sort or filter is rejected at any position, and a matching cursor left past the last row by an index that shrank between pages returns an exhausted page rather than throwing.
+
+- 86a555b: The roadmap contract surfaces are now shipped across the public packages: shared island triggers,
+  typed content indexes and joins, client loader/action hooks, and unified static, dynamic, and
+  intercepting boundary modes. WebSocket routes also support opt-in synchronous outbound validation
+  through `sendSchema` + `validateSend`; invalid or asynchronous outbound frames fail closed while the
+  default remains type-level only.
+
+## 2.14.1
+
+## 2.14.0
+
+## 2.13.0
+
+## 2.12.1
+
+## 2.12.0
+
+## 2.11.0
+
+## 2.10.0
+
+## 2.9.1
+
+## 2.9.0
+
+## 2.8.2
+
+## 2.8.1
+
+## 2.8.0
+
+## 2.7.1
+
+## 2.7.0
+
+## 2.6.1
+
+## 2.6.0
+
+## 2.5.0
+
+## 2.4.0
+
+## 2.3.0
+
+## 2.2.0
+
+## 2.1.0
+
+## 2.0.0
+
+## 1.13.0
+
+## 1.12.0
+
+## 1.11.0
+
+## 1.10.0
+
+## 1.9.1
+
+## 1.9.0
+
+## 1.8.0
+
+## 1.7.0
+
+## 1.6.0
+
+## 1.5.0
+
+## 1.4.0
+
+## 1.3.1
+
+## 1.3.0
+
+## 1.2.2
+
+## 1.2.1
+
+## 1.2.0
+
+## 1.1.0
+
+## 1.0.0
+
+## 1.0.0-beta.4
+
+## 1.0.0-beta.3
+
+## 0.1.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nifrajs/content",
-  "version": "5.1.0",
+  "version": "5.3.0",
   "description": "Typed, schema-validated content collections for nifra - Markdown + frontmatter, framework-agnostic.",
   "keywords": [
     "bun",
@@ -36,7 +36,8 @@
     }
   },
   "files": [
-    "src"
+    "src",
+    "CHANGELOG.md"
   ],
   "sideEffects": false,
   "license": "MIT",

package/src/fs.ts

@@ -15,6 +15,11 @@ export interface CollectionConfig<S extends StandardSchemaV1> {
   readonly schema: S
   /** File extensions to include (default `[".md", ".markdown"]`). */
   readonly extensions?: readonly string[]
+  /** Look for changes on every `all()` (default `true`): a directory listing and a `stat` per file,
+   * so an edit shows without a restart. `false` lists and parses the directory once and returns that
+   * snapshot from then on, for a server whose content ships with its build. `get` checks its one
+   * file either way. */
+  readonly watch?: boolean
 }
 
 /** A typed collection over a content directory. */
@@ -80,6 +85,7 @@ export function defineCollection<S extends StandardSchemaV1>(
   const matches = (file: string): boolean => extensions.some((ext) => file.endsWith(ext))
   const fileCache = new Map<string, CachedEntry<InferSchema<S>>>()
   let collectionCache: CollectionSnapshot<InferSchema<S>> | undefined
+  let frozen: Promise<Array<Entry<InferSchema<S>>>> | undefined
 
   const readEntry = async (
     path: string,
@@ -109,20 +115,32 @@ export function defineCollection<S extends StandardSchemaV1>(
     )
   }
 
+  const load = async (): Promise<Array<Entry<InferSchema<S>>>> => {
+    const files = await listFiles()
+    const fingerprint = files.map((file) => `${file.file}\0${file.stamp}`).join("\0")
+    if (collectionCache?.fingerprint === fingerprint) return collectionCache.entries
+
+    const listed = new Set(files.map((file) => file.path))
+    for (const path of fileCache.keys()) if (!listed.has(path)) fileCache.delete(path)
+    const entries = await Promise.all(
+      files.map((file) => readEntry(file.path, slugOf(file.file), file.stamp)),
+    )
+    collectionCache = {
+      fingerprint,
+      entries,
+    }
+    return entries
+  }
+
   return {
     async all() {
-      const files = await listFiles()
-      const fingerprint = files.map((file) => `${file.file}\0${file.stamp}`).join("\0")
-      if (collectionCache?.fingerprint === fingerprint) return [...collectionCache.entries]
-
-      const entries = await Promise.all(
-        files.map((file) => readEntry(file.path, slugOf(file.file), file.stamp)),
-      )
-      collectionCache = {
-        fingerprint,
-        entries,
-      }
-      return [...entries]
+      if (config.watch !== false) return [...(await load())]
+      // A failed first read is not kept, so the next call retries it.
+      frozen ??= load().catch((error: unknown) => {
+        frozen = undefined
+        throw error
+      })
+      return [...(await frozen)]
     },
     async get(slug) {
       if (!isSafeSlug(slug)) return null
@@ -134,6 +152,7 @@ export function defineCollection<S extends StandardSchemaV1>(
         try {
           stat = await statPath(file)
         } catch {
+          fileCache.delete(file)
           continue // Not this extension; try the next configured one.
         }
         if (!stat.isFile()) continue