@terrafirmagreg-team/guide 0.0.0-stage → 1.2.0

package/src/components/views/entry/pages.tsx

@@ -0,0 +1,188 @@
+import type { DatasetRef } from '@terrafirmagreg-team/sites/location';
+import type { ReactNode } from 'react';
+import { PageText } from '@terrafirmagreg-team/guide/components/views/page/text';
+import {
+  EntityPage,
+  ImagePage,
+  MultiMultiblockPage,
+  MultiblockPage,
+  MultiblockVisual,
+} from '@terrafirmagreg-team/guide/components/views/kind/media';
+import {
+  LinkPage,
+  QuestPage,
+  RelationPage,
+} from '@terrafirmagreg-team/guide/components/views/kind/links';
+import {
+  RecipePage,
+  SpotlightPage,
+} from '@terrafirmagreg-team/guide/components/views/kind/recipe';
+import { TablePage } from '@terrafirmagreg-team/guide/components/views/kind/table';
+import { UnknownPage } from '@terrafirmagreg-team/guide/components/views/kind/unknown';
+import type { PageRendererProps } from '@terrafirmagreg-team/guide/types';
+import type { AtlasBundle } from '@terrafirmagreg-team/dump/lib/dump/assets/atlas/dto';
+import type { Lang } from '@terrafirmagreg-team/translate/types/locale';
+import { guideMessage } from '@terrafirmagreg-team/guide/lib/messages';
+import type { PagePreviewData } from '@terrafirmagreg-team/ui/types/preview';
+import type { GuideBookMeta } from '@terrafirmagreg-team/guide/types';
+import type {
+  GuideBook,
+  GuideEntryExtras,
+  GuideEntryRef,
+  GuideMessages,
+  GuidePage,
+} from '@terrafirmagreg-team/guide/types';
+import {
+  guidePageTitles,
+  pageAnchors,
+  pageIcons,
+  repeatedTitle,
+} from '@terrafirmagreg-team/guide/lib/toc';
+import { classify, isIndexPage, type PageKind, pageTexts } from '@terrafirmagreg-team/guide/lib/page-kind';
+import {
+  EntryGroup,
+  GROUP_CYCLE_MS,
+} from '@terrafirmagreg-team/game/components/entry/group';
+import { Entry } from '@terrafirmagreg-team/game/components/entry/entry';
+
+const renderers: Record<
+  Exclude<PageKind, 'empty' | 'text'>,
+  (props: PageRendererProps) => ReactNode
+> = {
+  image: ImagePage,
+  recipe: RecipePage,
+  spotlight: SpotlightPage,
+  entity: EntityPage,
+  multiblock: MultiblockPage,
+  multimultiblock: MultiMultiblockPage,
+  link: LinkPage,
+  relations: RelationPage,
+  quest: QuestPage,
+  table: TablePage,
+  unknown: UnknownPage,
+};
+
+export function EntryPages({
+  dataset,
+  lang,
+  bookPath,
+  pages,
+  atlases,
+  meta,
+  bookModId,
+  categoryByEntry,
+  book,
+  langMap,
+  entryRefs,
+  keybinds,
+  extras,
+  questLinks,
+  previews,
+  messages,
+}: {
+  dataset: DatasetRef;
+  lang: Lang;
+  bookPath: string;
+  pages: GuidePage[];
+  atlases?: Record<string, AtlasBundle>;
+  meta?: GuideBookMeta;
+  bookModId: string;
+  categoryByEntry: Map<string, string>;
+  book?: GuideBook | null;
+  langMap: Record<string, string>;
+  entryRefs: Map<string, GuideEntryRef>;
+  keybinds?: Record<string, string>;
+  extras?: GuideEntryExtras;
+  questLinks?: Record<string, { filename: string; questId: string }>;
+  previews?: Record<string, PagePreviewData>;
+  messages: GuideMessages;
+}) {
+  const titles = guidePageTitles(
+    pages,
+    langMap,
+    {
+      related: guideMessage(messages, 'guide.related'),
+      objective: guideMessage(messages, 'guide.objective'),
+    },
+    extras?.entityNames,
+  );
+  const anchors = pageAnchors(pages);
+  return (
+    <div className="space-y-6">
+      {pages.map((page, index) => {
+        if (isIndexPage(page, langMap)) return null;
+        const kind = classify(page.type);
+        const attachedValue =
+          kind === 'multiblock' || kind === 'multimultiblock'
+            ? undefined
+            : (page.model ?? page.multiblock);
+        if (kind === 'empty' && !attachedValue && !pageTexts(page).length) {
+          return null;
+        }
+        const rendererProps: PageRendererProps = {
+          dataset,
+          lang,
+          bookPath,
+          page,
+          atlases,
+          meta: meta ?? {},
+          bookModId,
+          categoryByEntry,
+          langMap,
+          entryRefs,
+          keybinds,
+          book,
+          extras,
+          questLinks,
+          previews,
+          messages,
+        };
+        const Renderer =
+          kind === 'text' || kind === 'empty' ? undefined : renderers[kind];
+        const heading =
+          kind === 'image' || repeatedTitle(titles, index)
+            ? undefined
+            : titles[index];
+        const icons = pageIcons(page);
+        return (
+          <section
+            key={index}
+            id={anchors[index]}
+            className="scroll-mt-20 space-y-3"
+          >
+            {heading ? (
+              <h2 className="flex items-center gap-2 text-xl font-semibold">
+                {icons.length > 1 ? (
+                  <EntryGroup members={icons} size="lg" cycle={GROUP_CYCLE_MS} />
+                ) : icons[0] ? (
+                  <Entry
+                    id={icons[0].id}
+                    kind={icons[0].kind}
+                    dataset={dataset}
+                    name={heading}
+                    href={false}
+                    tooltip={false}
+                    missing="hide"
+                  />
+                ) : null}
+                {heading}
+              </h2>
+            ) : null}
+            {attachedValue ? (
+              <MultiblockVisual
+                value={attachedValue}
+                title={
+                  typeof page.name === 'string' ? page.name : undefined
+                }
+                glbs={extras?.glbs}
+              />
+            ) : null}
+            {Renderer ? <Renderer {...rendererProps} /> : null}
+            <PageText {...rendererProps} />
+          </section>
+        );
+      })}
+    </div>
+  );
+}
+

package/src/components/views/entry/view.tsx

@@ -0,0 +1,62 @@
+import type { DatasetRef } from '@terrafirmagreg-team/sites/location';
+import { EntryPages } from '@terrafirmagreg-team/guide/components/views/entry/pages';
+import type { PagePreviewData } from '@terrafirmagreg-team/ui/types/preview';
+import type { Lang } from '@terrafirmagreg-team/translate/types/locale';
+import type {
+  GuideBook,
+  GuideEntry,
+  GuideEntryExtras,
+  GuideEntryRef,
+  GuideMessages,
+} from '@terrafirmagreg-team/guide/types';
+
+export function EntryView({
+  dataset,
+  lang,
+  bookPath,
+  entry,
+  bookModId,
+  categoryByEntry,
+  book,
+  langMap,
+  entryRefs,
+  extras,
+  questLinks,
+  previews,
+  messages,
+}: {
+  dataset: DatasetRef;
+  lang: Lang;
+  bookPath: string;
+  entry: GuideEntry;
+  bookModId: string;
+  categoryByEntry: Map<string, string>;
+  book?: GuideBook | null;
+  langMap: Record<string, string>;
+  entryRefs: Map<string, GuideEntryRef>;
+  extras?: GuideEntryExtras;
+  questLinks?: Record<string, { filename: string; questId: string }>;
+  previews?: Record<string, PagePreviewData>;
+  messages: GuideMessages;
+}) {
+  return (
+    <EntryPages
+      dataset={dataset}
+      lang={lang}
+      bookPath={bookPath}
+      pages={entry.pages ?? []}
+      atlases={extras?.atlases}
+      bookModId={bookModId}
+      categoryByEntry={categoryByEntry}
+      book={book}
+      langMap={langMap}
+      entryRefs={entryRefs}
+      keybinds={extras?.keybinds}
+      extras={extras}
+      questLinks={questLinks}
+      previews={previews}
+      messages={messages}
+    />
+  );
+}
+

package/src/components/views/kind/links.tsx

@@ -0,0 +1,112 @@
+import { LinkPreview } from '@terrafirmagreg-team/ui/components/blocks/link/link-preview';
+import { Entry } from '@terrafirmagreg-team/game/components/entry/entry';
+import { guideEmbeds } from '@terrafirmagreg-team/guide/lib/embeds';
+import { guideMessage } from '@terrafirmagreg-team/guide/lib/messages';
+import {
+  entryLabel,
+  entryRef,
+  spriteName,
+} from '@terrafirmagreg-team/guide/lib/names';
+import { referenceHref } from '@terrafirmagreg-team/guide/lib/reference';
+import { parseGuideReference } from '@terrafirmagreg-team/guide/lib/reference/resolver';
+import type { PageRendererProps } from '@terrafirmagreg-team/guide/types';
+
+export function RelationPage(props: PageRendererProps) {
+  const ids = (props.page.entries ?? []).filter(
+    (value): value is string => typeof value === 'string' && Boolean(value),
+  );
+  if (!ids.length) return null;
+  return (
+    <ul className="space-y-1">
+      {ids.map((id) => {
+        const resolved = referenceHref(props, id);
+        const ref = entryRef(props.entryRefs, id);
+        const name = entryLabel(props.entryRefs, props.langMap, id);
+        return (
+          <li key={id} className="flex items-center gap-2">
+            {ref?.icon ? (
+              <Entry
+                id={ref.icon.id}
+                kind={ref.icon.kind}
+                dataset={props.dataset}
+                size="sm"
+                href={false}
+                tooltip={false}
+              />
+            ) : null}
+            {resolved ? (
+              <LinkPreview
+                variant="text"
+                href={resolved.href}
+                preview={props.previews?.[resolved.href]}
+              >
+                {name}
+              </LinkPreview>
+            ) : (
+              <span className="text-muted-foreground">{name}</span>
+            )}
+          </li>
+        );
+      })}
+    </ul>
+  );
+}
+
+export function LinkPage(props: PageRendererProps) {
+  const target = props.page.url || props.page.link || props.page.entry || '';
+  const resolved = target ? referenceHref(props, target) : null;
+  const label =
+    (typeof props.page.link_text === 'string' && props.page.link_text) ||
+    (typeof props.page.text === 'string' && props.page.text) ||
+    (typeof props.page.name === 'string' && props.page.name) ||
+    target ||
+    guideMessage(props.messages, 'guide.link');
+  return (
+    <p>
+      {resolved ? (
+        <LinkPreview
+          variant="chip"
+          solid
+          href={resolved.href}
+          preview={props.previews?.[resolved.href]}
+        >
+          {label}
+        </LinkPreview>
+      ) : (
+        <span className="text-muted-foreground">{label}</span>
+      )}
+    </p>
+  );
+}
+
+export function QuestPage({
+  dataset,
+  page,
+  lang,
+  langMap,
+  atlases,
+  questLinks,
+  previews,
+  messages,
+}: PageRendererProps) {
+  const id = page.trigger || page.quest || page.link;
+  const hit = id ? questLinks?.[parseGuideReference(id).id] : undefined;
+  const href = hit
+    ? guideEmbeds().quest?.href(dataset, lang, { category: hit.filename, id: hit.questId })
+    : undefined;
+  const name = id ? spriteName(dataset, langMap, atlases, id) : '—';
+  const label = id && name !== id ? name : <code>{name}</code>;
+  return (
+    <p className="text-sm text-muted-foreground">
+      {guideMessage(messages, 'guide.quest')}:{' '}
+      {href ? (
+        <LinkPreview href={href} preview={previews?.[href]}>
+          {label}
+        </LinkPreview>
+      ) : (
+        label
+      )}
+    </p>
+  );
+}
+

package/src/components/views/kind/media.tsx

@@ -0,0 +1,168 @@
+import { useMemo } from 'react';
+import { GuideText } from '@terrafirmagreg-team/guide/components/views/text';
+import { useDumpLocation } from '@terrafirmagreg-team/game/hooks/use-dump-location';
+import { asMultiblock } from '@terrafirmagreg-team/guide/lib/meta';
+import {
+  createDumpAssetResolver,
+  texturePublicUrl,
+} from '@terrafirmagreg-team/dump/lib/dump/assets/urls';
+import { dumpRelPublicUrl } from '@terrafirmagreg-team/dump/lib/dump/paths';
+import { parseStackId } from '@terrafirmagreg-team/dump/lib/dump/contract/ref';
+import { langString } from '@terrafirmagreg-team/dump/lib/dump/assets/lang/names';
+import { matchVariant } from '@terrafirmagreg-team/dump/lib/dump/data/registry/parse';
+import { GlbViewer } from '@terrafirmagreg-team/ui/components/blocks/media/glb/viewer';
+import { multiblockKey } from '@terrafirmagreg-team/guide/lib/multiblock';
+import { guideFormatOpts } from '@terrafirmagreg-team/guide/lib/format';
+import { spriteName } from '@terrafirmagreg-team/guide/lib/names';
+import type { PageRendererProps } from '@terrafirmagreg-team/guide/types';
+import { GlbPlaceholder } from '@terrafirmagreg-team/ui/components/blocks/media/glb/viewer';
+import { Slideshow } from '@terrafirmagreg-team/ui/components/blocks/media/slideshow';
+import type { GuideMultiblock } from '@terrafirmagreg-team/guide/types';
+
+export function ImagePage(props: PageRendererProps) {
+  const { dataset, page } = props;
+  useDumpLocation(dataset);
+  const images = [
+    ...(page.images ?? []),
+    ...(typeof page.image === 'string' ? [page.image] : []),
+  ];
+  const opts = guideFormatOpts(props);
+  const title =
+    typeof page.title === 'string' && page.title ? (
+      <GuideText text={page.title} {...opts} />
+    ) : null;
+  return (
+    <Slideshow
+      images={
+        images.length
+          ? images.map((id) => ({
+              id,
+              url: texturePublicUrl(dataset, id) ?? null,
+            }))
+          : [{ id: 'missing', url: null }]
+      }
+      alt={typeof page.title === 'string' ? page.title : ''}
+      border={page.border !== false}
+      scale={page.scale}
+      offset={page.offset}
+      rotate={page.rotate}
+      caption={title ?? undefined}
+    />
+  );
+}
+
+export function EntityPage({
+  dataset,
+  page,
+  langMap,
+  atlases,
+  extras,
+}: PageRendererProps) {
+  const id = typeof page.entity === 'string' ? page.entity : undefined;
+  useDumpLocation(dataset);
+  const resolveResource = useMemo(
+    () => createDumpAssetResolver(dataset),
+    [dataset],
+  );
+  const parsed = id ? parseStackId(id) : undefined;
+  const entry = parsed?.id ? extras?.entities?.[parsed.id] : undefined;
+  const variant = matchVariant(entry?.variants, parsed?.nbt);
+  const model = variant?.model ?? entry?.model;
+  const ns = parsed?.id.split(':', 1)[0];
+  const glb =
+    model && ns
+      ? dumpRelPublicUrl(dataset, `assets/${ns}/${model}`)
+      : undefined;
+  const name = id
+    ? (langString(langMap, variant?.display?.name) ??
+      langString(langMap, entry?.display?.name) ??
+      spriteName(dataset, langMap, atlases, id))
+    : undefined;
+  return (
+    <div className="space-y-2">
+      {glb ? (
+        <GlbViewer
+          src={glb}
+          title={name}
+          scale={typeof page.scale === 'number' ? page.scale : undefined}
+          offset={typeof page.offset === 'number' ? page.offset : undefined}
+          resolveResource={resolveResource}
+        />
+      ) : (
+        <GlbPlaceholder title={name} />
+      )}
+    </div>
+  );
+}
+
+function MissingVisual({ title }: { title?: string }) {
+  return <GlbPlaceholder title={title} />;
+}
+
+export function MultiblockVisual({
+  value,
+  title,
+  glbs,
+  resolveResource,
+}: {
+  value: string | GuideMultiblock | undefined;
+  title?: string;
+  glbs?: Record<string, string>;
+  resolveResource?: (
+    resourceUrl: string,
+    modelUrl: string,
+  ) => string | undefined;
+}) {
+  const spec = asMultiblock(value);
+  const key = multiblockKey(spec);
+  const src = key ? glbs?.[key] : undefined;
+  return src ? (
+    <GlbViewer src={src} title={title} resolveResource={resolveResource} />
+  ) : (
+    <MissingVisual title={title} />
+  );
+}
+
+export function MultiblockPage({ page, dataset, extras }: PageRendererProps) {
+  const modelId = typeof page.model === 'string' ? page.model : undefined;
+  useDumpLocation(dataset);
+  const resolveResource = useMemo(
+    () => createDumpAssetResolver(dataset),
+    [dataset],
+  );
+  return (
+    <MultiblockVisual
+      value={modelId ?? page.multiblock}
+      title={modelId ?? page.name}
+      glbs={extras?.glbs}
+      resolveResource={resolveResource}
+    />
+  );
+}
+
+export function MultiMultiblockPage({
+  page,
+  dataset,
+  extras,
+}: PageRendererProps) {
+  useDumpLocation(dataset);
+  const resolveResource = useMemo(
+    () => createDumpAssetResolver(dataset),
+    [dataset],
+  );
+  const specs = (page.multiblocks ?? []).map(asMultiblock);
+  const glbs = specs
+    .map((spec) => multiblockKey(spec))
+    .map((key) => (key ? extras?.glbs?.[key] : undefined))
+    .filter((url): url is string => Boolean(url));
+  return glbs.length ? (
+    <GlbViewer
+      sources={glbs}
+      title={page.name}
+      resolveResource={resolveResource}
+    />
+  ) : (
+    <MissingVisual title={page.name} />
+  );
+}
+

package/src/components/views/kind/recipe.tsx

@@ -0,0 +1,89 @@
+'use client';
+import { Card } from '@terrafirmagreg-team/ui/components/ui/card';
+import { EmptyState } from '@terrafirmagreg-team/ui/components/blocks/page/empty-state';
+import { guideEmbeds } from '@terrafirmagreg-team/guide/lib/embeds';
+import { Entry } from '@terrafirmagreg-team/game/components/entry/entry';
+import { EntryList } from '@terrafirmagreg-team/game/components/entry/list';
+import { guideMessage } from '@terrafirmagreg-team/guide/lib/messages';
+import { collectItemIds } from '@terrafirmagreg-team/guide/lib/data/parse';
+import { pageTitle } from '@terrafirmagreg-team/guide/lib/toc';
+import { spriteName } from '@terrafirmagreg-team/guide/lib/names';
+import { recipeIds, recipeNameScope } from '@terrafirmagreg-team/guide/lib/recipe';
+
+import type { PageRendererProps } from '@terrafirmagreg-team/guide/types';
+
+export function RecipePage({
+  dataset,
+  page,
+  lang,
+  langMap,
+  atlases,
+  extras,
+  messages,
+}: PageRendererProps) {
+  const ids = recipeIds(page);
+  if (!ids.length) {
+    return (
+      <EmptyState variant="empty">
+        {guideMessage(messages, 'guide.recipe_empty')}
+      </EmptyState>
+    );
+  }
+  const RecipeCard = guideEmbeds().recipe?.Card;
+  return (
+    <div className="space-y-4">
+      {ids.map((id) => {
+        const recipe = extras?.recipes?.[id];
+        if (recipe && RecipeCard) {
+          return (
+            <RecipeCard
+              key={id}
+              id={id}
+              recipe={recipe}
+              dataset={dataset}
+              lang={lang}
+              langMap={recipeNameScope(langMap, recipe)}
+            />
+          );
+        }
+        const name = spriteName(dataset, langMap, atlases, id);
+        return (
+          <Card key={id} className="flex-row items-center gap-2 px-3 py-2">
+            {id.includes(':') ? (
+              <Entry
+                id={id}
+                kind="item"
+                dataset={dataset}
+                name={name}
+                labeled
+                label={name}
+              />
+            ) : (
+              <span className="text-sm">{name}</span>
+            )}
+          </Card>
+        );
+      })}
+    </div>
+  );
+}
+
+export function SpotlightPage({
+  dataset,
+  page,
+  langMap,
+  extras,
+}: PageRendererProps) {
+  if (pageTitle(page, langMap, {}, extras?.entityNames)) return null;
+  const ids = [...collectItemIds(page.item), ...collectItemIds(page.icon)];
+  if (!ids.length) return null;
+  return (
+    <EntryList
+      variant="row"
+      labeled
+      dataset={dataset}
+      items={ids.map((id) => ({ id, kind: 'item' as const }))}
+    />
+  );
+}
+