@terrafirmagreg-team/dump 0.0.0-stage → 1.2.0

package/src/lib/dump/data/registry/parse.ts

@@ -0,0 +1,291 @@
+import {
+  asEdgeList,
+  asNumber,
+  asRecord,
+  asString,
+  asStringList,
+} from '@terrafirmagreg-team/dump/lib/dump/contract/read';
+import {
+  asNbt,
+  asTaggedReference,
+  nbtSpecificity,
+  type DumpNbt,
+} from '@terrafirmagreg-team/dump/lib/dump/contract/ref';
+import { formatNbt } from '@terrafirmagreg-team/dump/lib/snbt';
+import { asDisplay, type DumpDisplay } from '@terrafirmagreg-team/dump/lib/dump/contract/text';
+import type {
+  DumpBlockEntry,
+  DumpEntityEntry,
+  DumpEntryVariant,
+  DumpFluidEntry,
+  DumpItemEntry,
+  DumpRegistryEntry,
+  DumpRegistryKind,
+  SpriteEntry,
+} from '@terrafirmagreg-team/dump/lib/dump/data/registry/dto';
+
+export function asSpriteEntry(value: unknown): SpriteEntry | undefined {
+  const row = asRecord(value);
+  if (!row) return undefined;
+  const image = asString(row.image);
+  const x = asNumber(row.x);
+  const y = asNumber(row.y);
+  const w = asNumber(row.w);
+  const h = asNumber(row.h);
+  const pw = asNumber(row.pw);
+  const ph = asNumber(row.ph);
+  if (
+    !image ||
+    x === undefined ||
+    y === undefined ||
+    w === undefined ||
+    h === undefined ||
+    pw === undefined ||
+    ph === undefined
+  ) {
+    return undefined;
+  }
+  const tint = asString(row.tint);
+  const tintColor = asString(row.tintColor);
+  return {
+    image,
+    x,
+    y,
+    w,
+    h,
+    pw,
+    ph,
+    ...(tint ? { tint } : {}),
+    ...(tintColor ? { tintColor } : {}),
+  };
+}
+
+function asVariant(value: unknown): DumpEntryVariant | undefined {
+  const row = asRecord(value);
+  if (!row) return undefined;
+  const tag = asNbt(row.tag);
+  if (tag === undefined) return undefined;
+  const display = asDisplay(row.display);
+  const sprite = asSpriteEntry(row.sprite);
+  const texture = asString(row.texture);
+  const model = asString(row.model);
+  return {
+    tag,
+    ...(display ? { display } : {}),
+    ...(sprite ? { sprite } : {}),
+    ...(texture ? { texture } : {}),
+    ...(model ? { model } : {}),
+  };
+}
+
+function asVariants(value: unknown): DumpEntryVariant[] | undefined {
+  if (!Array.isArray(value)) return undefined;
+  const out = value.flatMap((item) => {
+    const variant = asVariant(item);
+    return variant ? [variant] : [];
+  });
+  return out.length ? out : undefined;
+}
+
+const EXACT_SAFE_MAX_KEYS = 99;
+
+const variantExactIndex = new WeakMap<
+  DumpEntryVariant[],
+  { byTag: Map<string, DumpEntryVariant>; maxTagKeys: number }
+>();
+
+function exactVariantIndex(variants: DumpEntryVariant[]) {
+  let index = variantExactIndex.get(variants);
+  if (!index) {
+    const byTag = new Map<string, DumpEntryVariant>();
+    let maxTagKeys = 0;
+    for (const variant of variants) {
+      if (variant.tag === undefined) continue;
+      const keyCount =
+        variant.tag !== null &&
+        typeof variant.tag === 'object' &&
+        !Array.isArray(variant.tag)
+          ? Object.keys(variant.tag).length
+          : 0;
+      if (keyCount > maxTagKeys) maxTagKeys = keyCount;
+      const key = formatNbt(variant.tag);
+      if (key !== undefined && !byTag.has(key)) byTag.set(key, variant);
+    }
+    index = { byTag, maxTagKeys };
+    variantExactIndex.set(variants, index);
+  }
+  return index;
+}
+
+export function matchVariant(
+  variants: DumpEntryVariant[] | undefined,
+  nbt: DumpNbt | undefined,
+): DumpEntryVariant | undefined {
+  if (!variants?.length) return undefined;
+  if (nbt === undefined) {
+    return variants.find((variant) => variant.tag === undefined);
+  }
+  const key = formatNbt(nbt);
+  const index =
+    variants.length > 16 && key !== undefined
+      ? exactVariantIndex(variants)
+      : undefined;
+  if (index && index.maxTagKeys <= EXACT_SAFE_MAX_KEYS && key !== undefined) {
+    const exact = index.byTag.get(key);
+    if (exact) return exact;
+  }
+  let best: DumpEntryVariant | undefined;
+  let bestScore = -1;
+  for (const variant of variants) {
+    if (variant.tag === undefined) continue;
+    const score = nbtSpecificity(variant.tag, nbt);
+    if (score > bestScore) {
+      best = variant;
+      bestScore = score;
+    }
+  }
+  return best;
+}
+
+export function displayOf(
+  entry: { display?: DumpDisplay; variants?: DumpEntryVariant[] },
+  nbt?: DumpNbt,
+): DumpDisplay | undefined {
+  return matchVariant(entry.variants, nbt)?.display ?? entry.display;
+}
+
+function asId(value: unknown, fallbackId?: string): string | undefined {
+  const row = asRecord(value);
+  return asString(row?.id) ?? fallbackId;
+}
+
+function asEntryMeta(row: Record<string, unknown>, ids?: string[]) {
+  const tags = asStringList(row.tags);
+  const usedBy = asEdgeList(row.usedBy, ids);
+  const producedBy = asEdgeList(row.producedBy, ids);
+  const order = asNumber(row.order);
+  return {
+    ...(tags.length ? { tags } : {}),
+    ...(usedBy.length ? { usedBy } : {}),
+    ...(producedBy.length ? { producedBy } : {}),
+    ...(order !== undefined ? { order } : {}),
+  };
+}
+
+function asItemEntry(
+  value: unknown,
+  fallbackId?: string,
+  ids?: string[],
+): DumpItemEntry | undefined {
+  const id = asId(value, fallbackId);
+  if (!id) return undefined;
+  const row = asRecord(value);
+  if (!row) return undefined;
+  const rarity = asString(row.rarity);
+  const block = asString(row.block);
+  const maxCount =
+    typeof row.maxCount === 'number' && Number.isFinite(row.maxCount)
+      ? row.maxCount
+      : undefined;
+  const display = asDisplay(row.display);
+  const variants = asVariants(row.variants);
+  const sprite = asSpriteEntry(row.sprite);
+  return {
+    id,
+    ...(maxCount !== undefined ? { maxCount } : {}),
+    ...(rarity ? { rarity } : {}),
+    ...(block ? { block } : {}),
+    ...(display ? { display } : {}),
+    ...(variants ? { variants } : {}),
+    ...(sprite ? { sprite } : {}),
+    ...asEntryMeta(row, ids),
+  };
+}
+
+function asBlockEntry(
+  value: unknown,
+  fallbackId?: string,
+  ids?: string[],
+): DumpBlockEntry | undefined {
+  const id = asId(value, fallbackId);
+  if (!id) return undefined;
+  const row = asRecord(value);
+  if (!row) return undefined;
+  const item = asTaggedReference(row.item);
+  const display = asDisplay(row.display);
+  const sprite = asSpriteEntry(row.sprite);
+  return {
+    id,
+    ...(item ? { item } : {}),
+    ...(display ? { display } : {}),
+    ...(sprite ? { sprite } : {}),
+    ...asEntryMeta(row, ids),
+  };
+}
+
+function asFluidEntry(
+  value: unknown,
+  fallbackId?: string,
+  ids?: string[],
+): DumpFluidEntry | undefined {
+  const id = asId(value, fallbackId);
+  if (!id) return undefined;
+  const row = asRecord(value);
+  if (!row) return undefined;
+  const display = asDisplay(row.display);
+  const variants = asVariants(row.variants);
+  const sprite = asSpriteEntry(row.sprite);
+  return {
+    id,
+    ...(display ? { display } : {}),
+    ...(variants ? { variants } : {}),
+    ...(sprite ? { sprite } : {}),
+    ...asEntryMeta(row, ids),
+  };
+}
+
+function asEntityEntry(
+  value: unknown,
+  fallbackId?: string,
+  ids?: string[],
+): DumpEntityEntry | undefined {
+  const id = asId(value, fallbackId);
+  if (!id) return undefined;
+  const row = asRecord(value);
+  if (!row) return undefined;
+  const display = asDisplay(row.display);
+  const texture = asString(row.texture);
+  const model = asString(row.model);
+  const variants = asVariants(row.variants);
+  return {
+    id,
+    ...(display ? { display } : {}),
+    ...(texture ? { texture } : {}),
+    ...(model ? { model } : {}),
+    ...(variants ? { variants } : {}),
+    ...asEntryMeta(row, ids),
+  };
+}
+
+export function asEntry(
+  value: unknown,
+  kind: DumpRegistryKind,
+  fallbackId?: string,
+  ids?: string[],
+): DumpRegistryEntry | undefined {
+  switch (kind) {
+    case 'items':
+      return asItemEntry(value, fallbackId, ids);
+    case 'blocks':
+      return asBlockEntry(value, fallbackId, ids);
+    case 'fluids':
+      return asFluidEntry(value, fallbackId, ids);
+    case 'entities':
+      return asEntityEntry(value, fallbackId, ids);
+    default: {
+      const _never: never = kind;
+      return _never;
+    }
+  }
+}
+

package/src/lib/dump/data/tab/dto.ts

@@ -0,0 +1,14 @@
+import type { DumpDisplay } from '@terrafirmagreg-team/dump/lib/dump/contract/text';
+import type { TaggedReference } from '@terrafirmagreg-team/dump/lib/dump/contract/ref';
+import type { TabEntry } from '@terrafirmagreg-team/dump/lib/dump/gen';
+
+export type DumpCreativeTab = Omit<TabEntry, 'display' | 'icon' | 'items'> & {
+  display: DumpDisplay;
+  icon?: TaggedReference;
+};
+
+export type DumpCreativeTabs = {
+  tabs: DumpCreativeTab[];
+  members: Record<string, string[]>;
+};
+

package/src/lib/dump/data/tab/parse.ts

@@ -0,0 +1,27 @@
+import { asRecord, asString } from '@terrafirmagreg-team/dump/lib/dump/contract/read';
+import { asTaggedReference, compactRefId } from '@terrafirmagreg-team/dump/lib/dump/contract/ref';
+import { asDisplay } from '@terrafirmagreg-team/dump/lib/dump/contract/text';
+import type { DumpCreativeTab } from '@terrafirmagreg-team/dump/lib/dump/data/tab/dto';
+
+export function asTab(value: unknown): DumpCreativeTab | undefined {
+  const row = asRecord(value);
+  if (!row) return undefined;
+  const id = asString(row.id);
+  const display = asDisplay(row.display);
+  const name = display?.name;
+  if (!id || !name) return undefined;
+  const order =
+    typeof row.order === 'number' && Number.isFinite(row.order) ? row.order : 0;
+  const icon = asTaggedReference(row.icon);
+  return { id, order, display: { ...display, name }, ...(icon ? { icon } : {}) };
+}
+
+export function asTabItems(value: unknown): string[] {
+  const row = asRecord(value);
+  if (!row || !Array.isArray(row.items)) return [];
+  return row.items.flatMap((item) => {
+    const id = compactRefId(item);
+    return id ? [id] : [];
+  });
+}
+

package/src/lib/dump/data/tag/dto.ts

@@ -0,0 +1,8 @@
+import type { TagEntry } from '@terrafirmagreg-team/dump/lib/dump/gen';
+
+export type DumpTag = Omit<TagEntry, 'members' | 'usedBy' | 'producedBy'> & {
+  members: string[];
+  usedBy: string[];
+  producedBy: string[];
+};
+

package/src/lib/dump/data/tag/parse.ts

@@ -0,0 +1,58 @@
+import {
+  asEdgeList,
+  asRecord,
+  asString,
+  asStringList,
+} from '@terrafirmagreg-team/dump/lib/dump/contract/read';
+import type { DumpTag } from '@terrafirmagreg-team/dump/lib/dump/data/tag/dto';
+
+const TAG_REGISTRIES = new Set(['items', 'blocks', 'fluids', 'entities']);
+
+function registryFromCatalogKey(manifestKey: string): {
+  registry?: string;
+  path: string;
+  ns: string;
+} {
+  const colon = manifestKey.indexOf(':');
+  const ns = colon > 0 ? manifestKey.slice(0, colon) : '';
+  const rest = colon > 0 ? manifestKey.slice(colon + 1) : manifestKey;
+  const slash = rest.indexOf('/');
+  if (slash <= 0) return { ns, path: rest };
+  const registry = rest.slice(0, slash);
+  return {
+    ns,
+    path: rest.slice(slash + 1),
+    ...(TAG_REGISTRIES.has(registry) ? { registry } : {}),
+  };
+}
+
+export function asTag(
+  raw: unknown,
+  manifestKey: string,
+  ids?: string[],
+): DumpTag | undefined {
+  const row = asRecord(raw);
+  if (!row) return undefined;
+  const members = asStringList(row.members);
+  const usedBy = asEdgeList(row.usedBy, ids);
+  const producedBy = asEdgeList(row.producedBy, ids);
+  const parsed = registryFromCatalogKey(manifestKey);
+  const registry = asString(row.registry) ?? parsed.registry;
+  if (!registry) return undefined;
+  const id =
+    asString(row.id) ?? (parsed.ns && parsed.path ? `${parsed.ns}:${parsed.path}` : '');
+  if (!id) return undefined;
+  return {
+    id,
+    registry,
+    replace: row.replace === true,
+    members,
+    usedBy,
+    producedBy,
+  };
+}
+
+export function firstTagItem(tag: DumpTag | undefined): string | undefined {
+  return tag?.members.find((value) => value && !value.startsWith('#'));
+}
+

package/src/lib/dump/gen/data/guides/book.ts

@@ -0,0 +1,57 @@
+export type ResourceId = string;
+export type ReferenceKind =
+  | "item"
+  | "block"
+  | "fluid"
+  | "entity"
+  | "itemTag"
+  | "blockTag"
+  | "fluidTag"
+  | "entityTag"
+  | "texture"
+  | "model"
+  | "recipe";
+
+export interface DataGuidesBook {
+  categories: {
+    [k: string]: string | undefined;
+  };
+  cover?: null | TaggedReference;
+  display: GuideDisplay;
+  entries: {
+    [k: string]: string | undefined;
+  };
+  extensions?: {
+    [k: string]: JsonNode | undefined;
+  };
+  i18n?: boolean;
+  id?: string;
+  macros?: {
+    [k: string]: string | undefined;
+  };
+  model?: string;
+  order: number;
+  schema: "data/guides/book";
+  slug?: string;
+  subtitle?: string;
+}
+export interface TaggedReference {
+  id: ResourceId;
+  kind: ReferenceKind;
+  tag?: JsonNode;
+}
+export interface JsonNode {
+  [k: string]: unknown | undefined;
+}
+export interface GuideDisplay {
+  landing: DumpText[];
+  name: string;
+}
+export interface DumpText {
+  extra?: DumpText[];
+  keybind?: string;
+  text?: string;
+  translate?: string;
+  with?: DumpText[];
+}
+

package/src/lib/dump/gen/data/guides/category.ts

@@ -0,0 +1,31 @@
+export type ResourceId = string;
+export type ReferenceKind =
+  | "item"
+  | "block"
+  | "fluid"
+  | "entity"
+  | "itemTag"
+  | "blockTag"
+  | "fluidTag"
+  | "entityTag"
+  | "texture"
+  | "model"
+  | "recipe";
+
+export interface DataGuidesCategory {
+  description?: string;
+  icon?: TaggedReference;
+  name?: string;
+  order: number;
+  schema: "data/guides/category";
+  [k: string]: unknown | undefined;
+}
+export interface TaggedReference {
+  id: ResourceId;
+  kind: ReferenceKind;
+  tag?: JsonNode;
+}
+export interface JsonNode {
+  [k: string]: unknown | undefined;
+}
+

package/src/lib/dump/gen/data/guides/entry.ts

@@ -0,0 +1,49 @@
+export type ResourceId = string;
+export type ReferenceKind =
+  | "item"
+  | "block"
+  | "fluid"
+  | "entity"
+  | "itemTag"
+  | "blockTag"
+  | "fluidTag"
+  | "entityTag"
+  | "texture"
+  | "model"
+  | "recipe";
+
+export interface DataGuidesEntry {
+  [k: string]: GuideEntry | undefined;
+}
+export interface GuideEntry {
+  category?: string;
+  display: GuideDisplay;
+  icon?: TaggedReference;
+  order?: number;
+  pages: GuidePage[];
+  [k: string]: unknown | undefined;
+}
+export interface GuideDisplay {
+  landing: DumpText[];
+  name: string;
+}
+export interface DumpText {
+  extra?: DumpText[];
+  keybind?: string;
+  text?: string;
+  translate?: string;
+  with?: DumpText[];
+}
+export interface TaggedReference {
+  id: ResourceId;
+  kind: ReferenceKind;
+  tag?: JsonNode;
+}
+export interface JsonNode {
+  [k: string]: unknown | undefined;
+}
+export interface GuidePage {
+  type?: string;
+  [k: string]: unknown | undefined;
+}
+

package/src/lib/dump/gen/data/models/model.ts

@@ -0,0 +1,4 @@
+export interface DataModelsModel {
+  [k: string]: string | undefined;
+}
+

package/src/lib/dump/gen/data/quests/chapter.ts

@@ -0,0 +1,127 @@
+export type ResourceId = string;
+export type ReferenceKind =
+  | "item"
+  | "block"
+  | "fluid"
+  | "entity"
+  | "itemTag"
+  | "blockTag"
+  | "fluidTag"
+  | "entityTag"
+  | "texture"
+  | "model"
+  | "recipe";
+
+export interface DataQuestsChapter {
+  autofocusId?: string;
+  defaultHideDependencyLines?: boolean;
+  defaultQuestShape?: string;
+  description?: string[];
+  filename?: string;
+  group?: string;
+  icon?: TaggedReference;
+  id?: string;
+  images?: ChapterImage[];
+  orderIndex?: number;
+  questLinks?: {
+    [k: string]: QuestLink | undefined;
+  };
+  quests?: {
+    [k: string]: QuestEntry | undefined;
+  };
+  schema?: "data/quests/chapter";
+  subtitle?: string;
+  title?: string;
+  [k: string]: unknown | undefined;
+}
+export interface TaggedReference {
+  id: ResourceId;
+  kind: ReferenceKind;
+  tag?: JsonNode;
+}
+export interface JsonNode {
+  [k: string]: unknown | undefined;
+}
+export interface ChapterImage {
+  alignToCorner?: boolean;
+  alpha?: number;
+  animated?: boolean;
+  click?: string;
+  color?: number;
+  frameCount?: number;
+  frameH?: number;
+  frameSequence?: number[];
+  frameTime?: number;
+  frameW?: number;
+  h: number;
+  image: string;
+  rotation?: number;
+  w: number;
+  x: number;
+  y: number;
+  [k: string]: unknown | undefined;
+}
+export interface QuestLink {
+  icon?: TaggedReference;
+  id: string;
+  linkedQuest: string;
+  shape?: string;
+  size?: number;
+  x: number;
+  y: number;
+  [k: string]: unknown | undefined;
+}
+export interface QuestEntry {
+  canRepeat?: boolean;
+  dependencies?: string[];
+  description?: string[];
+  guidePage?: string;
+  hideDependencyLines?: boolean;
+  icon?: TaggedReference;
+  id: string;
+  image?: string;
+  invisible?: boolean;
+  minWidth?: number;
+  optional?: boolean;
+  rewards?: {
+    [k: string]: QuestReward | undefined;
+  };
+  shape?: string;
+  size?: number;
+  subtitle?: string;
+  tasks?: {
+    [k: string]: QuestTask | undefined;
+  };
+  title?: string;
+  x?: number;
+  y?: number;
+  [k: string]: unknown | undefined;
+}
+export interface QuestReward {
+  count?: number;
+  id?: string;
+  items?: TaggedReference[];
+  ref?: TaggedReference;
+  title?: string;
+  type: string;
+  xp?: number;
+  [k: string]: unknown | undefined;
+}
+export interface QuestTask {
+  biome?: string;
+  count?: number;
+  dimension?: string;
+  filter?: string;
+  filterRaw?: string;
+  icon?: TaggedReference;
+  id?: string;
+  itemFilter?: string;
+  items?: TaggedReference[];
+  optional?: boolean;
+  ref?: TaggedReference;
+  stage?: string;
+  title?: string;
+  type: string;
+  [k: string]: unknown | undefined;
+}
+

package/src/lib/dump/gen/data/quests/chapter_groups.ts

@@ -0,0 +1,12 @@
+export interface DataQuestsChapterGroups {
+  chapterGroups: {
+    [k: string]: QuestChapterGroup | undefined;
+  };
+  schema: "data/quests/chapter_groups";
+}
+export interface QuestChapterGroup {
+  id: string;
+  orderIndex?: number;
+  title?: string;
+}
+