@terrafirmagreg-team/guide 1.2.6 → 1.2.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terrafirmagreg-team/guide",
-  "version": "1.2.6",
+  "version": "1.2.8",
   "type": "module",
   "description": "Guide/books section",
   "license": "LGPL-3.0-only",
@@ -22,17 +22,17 @@
     "./types": "./src/types/index.ts"
   },
   "dependencies": {
-    "@terrafirmagreg-team/data": "^1.2.1",
-    "@terrafirmagreg-team/discussions": "^1.2.3",
-    "@terrafirmagreg-team/dump": "^1.2.2",
-    "@terrafirmagreg-team/game": "^1.2.3",
-    "@terrafirmagreg-team/kit": "^1.2.5",
-    "@terrafirmagreg-team/mdx": "^1.2.2",
-    "@terrafirmagreg-team/preview": "^1.2.1",
-    "@terrafirmagreg-team/search": "^1.2.3",
+    "@terrafirmagreg-team/data": "^1.2.2",
+    "@terrafirmagreg-team/discussions": "^1.2.6",
+    "@terrafirmagreg-team/dump": "^1.2.4",
+    "@terrafirmagreg-team/game": "^1.2.4",
+    "@terrafirmagreg-team/kit": "^1.2.9",
+    "@terrafirmagreg-team/mdx": "^1.2.4",
+    "@terrafirmagreg-team/preview": "^1.2.3",
+    "@terrafirmagreg-team/search": "^1.2.5",
     "@terrafirmagreg-team/sites": "^1.2.1",
-    "@terrafirmagreg-team/translate": "^1.2.4",
-    "@terrafirmagreg-team/ui": "^1.2.4",
+    "@terrafirmagreg-team/translate": "^1.2.6",
+    "@terrafirmagreg-team/ui": "^1.2.7",
     "fumadocs-core": "16.17.10",
     "lucide-react": "^1.63.0"
   },

package/src/components/tree/index.tsx

@@ -54,8 +54,9 @@ function bookLeaf(
   slug: string,
   raw: GuideBookJson | undefined,
   map: Record<string, string>,
-): PageTree.Item {
+): PageTree.Item | undefined {
   const book = toBook(raw, ref, slug, map);
+  if (!book.name.trim()) return undefined;
   const bookId = bookOptionId(ref.modId, ref.bookPath);
   return keyTreeNode({
     type: 'page',
@@ -73,6 +74,7 @@ async function datasetBookLeaves(
   const dump = await loadDatasetDump(dataset);
   if (!dump) return [];
   const taken = new Set<string>();
+  const seen = new Set<string>();
   const leaves: PageTree.Node[] = [];
   for (const mod of dump.mods) {
     const raws = await Promise.all(
@@ -85,14 +87,19 @@ async function datasetBookLeaves(
     for (const [i, ref] of mod.books.entries()) {
       const raw = raws[i];
       if (!raw) continue;
+      const bookId = bookOptionId(ref.modId, ref.bookPath);
+      if (seen.has(bookId)) continue;
       let slug = bookSlug(raw, ref);
       if (taken.has(slug)) {
         let n = 2;
         while (taken.has(`${slug}-${n}`)) n += 1;
         slug = `${slug}-${n}`;
       }
+      const leaf = bookLeaf(dataset, ref, slug, raw, langMap);
+      if (!leaf) continue;
       taken.add(slug);
-      leaves.push(bookLeaf(dataset, ref, slug, raw, langMap));
+      seen.add(bookId);
+      leaves.push(leaf);
     }
   }
   return leaves;

package/src/components/views/browser.tsx

@@ -2,12 +2,20 @@
 import { useEffect, useMemo } from 'react';
 import { useRouter } from 'next/navigation';
 import { useLocationSearchParams } from '@terrafirmagreg-team/ui/hooks/page/use-location-search';
-import { useAsyncValue } from '@terrafirmagreg-team/ui/hooks/use-async-value';
+import {
+  useAsyncResult,
+  useAsyncValue,
+} from '@terrafirmagreg-team/ui/hooks/use-async-value';
+import { useLastResult } from '@terrafirmagreg-team/ui/hooks/use-last-result';
 import { useVersionedDataset } from '@terrafirmagreg-team/kit/hooks/use-versioned-dataset';
+import { useDumpRetryNonce } from '@terrafirmagreg-team/kit/hooks/use-dump-status';
+import { DumpUnavailable } from '@terrafirmagreg-team/kit/components/views/unavailable';
+import { StaleBadge } from '@terrafirmagreg-team/kit/components/dump-status/stale-badge';
 import { useLangMap } from '@terrafirmagreg-team/game/hooks/use-lang-map';
 import { useResolvedLang } from '@terrafirmagreg-team/translate/hooks/use-resolved-lang';
 import { useTranslations } from '@terrafirmagreg-team/translate/hooks/use-translations';
 import { Skeleton } from '@terrafirmagreg-team/ui/components/ui/skeleton';
+import { EmptyState } from '@terrafirmagreg-team/ui/components/blocks/page/empty-state';
 import { WorkspaceBody } from '@terrafirmagreg-team/ui/components/layouts/workspace';
 import { GuidePageView } from '@terrafirmagreg-team/guide/components/views/page/view';
 import {
@@ -59,9 +67,13 @@ export function GuideBrowser({
     [params],
   );
   const source = getGuideSource();
-  const books = useAsyncValue(
-    () => source.books(dataset, lang),
-    [dataset, lang],
+  const nonce = useDumpRetryNonce();
+  const books = useLastResult(
+    useAsyncResult(
+      () => source.books(dataset, lang),
+      [dataset, lang, nonce],
+    ),
+    dataset.id,
   );
   const langMap = useLangMap(dataset, lang);
   const messages = useMemo<GuideMessages>(
@@ -87,47 +99,79 @@ export function GuideBrowser({
 
   const resolved = useResolvedLang();
   const canonical = useAsyncValue(
-    books && !bookId
+    books.value && !bookId
       ? async () => {
-          const book = books[0];
+          const book = books.value?.[0];
           if (!book) return undefined;
           const index = await source.book(dataset, lang, book.bookId);
           const first = index ? firstGuideEntryId(index) : undefined;
           return guideHref(dataset, resolved, book.bookId, first);
         }
       : undefined,
-    [books, bookId, dataset, lang, resolved],
+    [books.value, bookId, dataset, lang, resolved],
   );
 
   useEffect(() => {
     if (canonical) router.replace(canonical);
   }, [canonical, router]);
 
-  const payload = useAsyncValue(
-    langMap && bookId
-      ? () =>
-          source.payload(
-            dataset,
-            lang,
-            bookId,
-            entryId,
-            categoryId,
-            langMap,
-            messages,
-          )
-      : undefined,
-    [dataset, lang, bookId, entryId, categoryId, langMap, messages],
+  const payload = useLastResult(
+    useAsyncResult(
+      langMap && bookId
+        ? () =>
+            source.payload(
+              dataset,
+              lang,
+              bookId,
+              entryId,
+              categoryId,
+              langMap,
+              messages,
+            )
+        : undefined,
+      [dataset, lang, bookId, entryId, categoryId, langMap, messages, nonce],
+    ),
+    `${dataset.id}:${bookId ?? ''}`,
   );
 
   useEffect(() => {
-    if (payload?.title) {
-      document.title = `${payload.title} · ${datasetTitle} | ${guideConfig().appName}`;
+    if (payload.value?.title) {
+      document.title = `${payload.value.title} · ${datasetTitle} | ${guideConfig().appName}`;
     }
-  }, [payload?.title, datasetTitle]);
+  }, [payload.value?.title, datasetTitle]);
+
+  const unavailable = (
+    <WorkspaceBody>
+      <DumpUnavailable>
+        {t('Guide data is temporarily unavailable. Try again later.', {
+          note: 'guide.unavailable',
+        })}
+      </DumpUnavailable>
+    </WorkspaceBody>
+  );
 
-  if (!bookId || !payload || !langMap) {
+  if (books.error || (!books.pending && !books.value?.length)) {
+    return unavailable;
+  }
+  if (!bookId || !langMap || payload.pending) {
     return <GuideBrowserFallback />;
   }
-  return <GuidePageView payload={payload} langMap={langMap} />;
+  if (!payload.value) {
+    return payload.error ? (
+      unavailable
+    ) : (
+      <WorkspaceBody>
+        <EmptyState variant="missing">
+          {t('Entry not found', { note: 'guide.entry_missing' })}
+        </EmptyState>
+      </WorkspaceBody>
+    );
+  }
+  return (
+    <div className="relative flex-1">
+      {books.stale || payload.stale ? <StaleBadge /> : null}
+      <GuidePageView payload={payload.value} langMap={langMap} />
+    </div>
+  );
 }
 

package/src/hooks/use-left-sidebar-tree.ts

@@ -5,6 +5,7 @@ import type * as PageTree from 'fumadocs-core/page-tree';
 import { useLocationSearchParams } from '@terrafirmagreg-team/ui/hooks/page/use-location-search';
 import { useResolvedLang } from '@terrafirmagreg-team/translate/hooks/use-resolved-lang';
 import { useLastValue } from '@terrafirmagreg-team/ui/hooks/use-last-value';
+import { skeletonTree } from '@terrafirmagreg-team/ui/lib/tree';
 import { useGuideTree } from '@terrafirmagreg-team/guide/hooks/use-tree';
 import { guideQueryFromParams } from '@terrafirmagreg-team/guide/lib/nav/query';
 import { parseSectionLocation } from '@terrafirmagreg-team/sites/location';
@@ -19,10 +20,8 @@ export function useGuideLeftSidebarTree(tree: PageTree.Root): PageTree.Root {
     () => (datasetId ? { id: datasetId, version } : undefined),
     [datasetId, version],
   );
-  const runtime = useLastValue(
-    useGuideTree(dataset, lang, bookId),
-    dataset?.id ?? '',
-  );
+  const result = useGuideTree(dataset, lang, bookId);
+  const runtime = useLastValue(result.value, dataset?.id ?? '');
+  if (!runtime && result.pending) return skeletonTree();
   return runtime ?? tree;
 }
-

package/src/hooks/use-tree.ts

@@ -2,7 +2,8 @@
 import type { DatasetRef } from '@terrafirmagreg-team/sites/location';
 
 import type * as PageTree from 'fumadocs-core/page-tree';
-import { useAsyncValue } from '@terrafirmagreg-team/ui/hooks/use-async-value';
+import { useAsyncResult } from '@terrafirmagreg-team/ui/hooks/use-async-value';
+import { useDumpRetryNonce } from '@terrafirmagreg-team/kit/hooks/use-dump-status';
 import { loadClientGuideBook } from '@terrafirmagreg-team/guide/lib/client/books';
 import { listGuideBooks } from '@terrafirmagreg-team/guide/lib/book/list';
 import { guideTreeChildren } from '@terrafirmagreg-team/guide/components/tree/children';
@@ -12,8 +13,9 @@ export function useGuideTree(
   dataset: DatasetRef | undefined,
   lang: Lang,
   bookId: string | undefined,
-): PageTree.Root | undefined {
-  return useAsyncValue(
+): { value: PageTree.Root | undefined; pending: boolean; error: unknown } {
+  const nonce = useDumpRetryNonce();
+  return useAsyncResult(
     dataset
       ? async () => {
           const summaries = await listGuideBooks(dataset, lang);
@@ -29,7 +31,6 @@ export function useGuideTree(
           } satisfies PageTree.Root;
         }
       : undefined,
-    [dataset, lang, bookId],
+    [dataset, lang, bookId, nonce],
   );
 }
-

package/src/lib/config.ts

@@ -31,7 +31,7 @@ export type GuideConfig = {
 const { register: registerGuideConfig, get: guideConfig } = createConfigRegistry<
   GuideConfigInput,
   GuideConfig
->((overrides) => ({
+>('guide', (overrides) => ({
   appName: overrides.appName ?? uiConfig().brand?.name ?? '',
   components: {
     PageActions: (overrides.components?.PageActions ??