@mapletip/data 0.3.0 → 0.6.0

package/generated/monster-catalog-2-4.d.ts

@@ -0,0 +1,378 @@
+import type { CatalogFact } from './contract-2-catalog-fact.d.ts';
+/* Generated automatically from Rust-owned wire definitions. Do not edit. */
+
+export type CoverageKey = string;
+/**
+ * Historical overlay drop count, separate from native source coverage.
+ */
+export type MonsterHistoricalDropSummaryV2_2 =
+  | {
+      count: number;
+      sourceBuilds: NonEmptyVecString;
+      state: "known";
+    }
+  | {
+      state: "absent";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVecString = [string, ...string[]];
+/**
+ * Compact source-free projection of [`CollectionState`]. Empty partial
+ * observations collapse to `unknown`; `absent` still requires its coverage
+ * key, and known/partial item lists cannot be empty.
+ */
+export type CatalogCollection =
+  | {
+      items: NonEmptyVec_MonsterElementSummaryV2;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_MonsterElementSummaryV2;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_MonsterElementSummaryV2 = [MonsterElementSummaryV2, ...MonsterElementSummaryV2[]];
+/**
+ * Completeness state copied from the corresponding row's location summary.
+ */
+export type MonsterGeographyStateV2_3 = "known" | "absent" | "unresolved";
+export type SafeInt64 = number;
+/**
+ * Per-Monster location state and resolved client-placement counts.
+ */
+export type MonsterLocationSummaryV2_2 =
+  | {
+      mapCount: number;
+      placementCount: number;
+      state: "known";
+    }
+  | {
+      state: "absent";
+    }
+  | {
+      mapCount: number;
+      placementCount: number;
+      state: "unresolved";
+    };
+/**
+ * Compact catalog projection of [`FactState`]. It keeps the state and a
+ * positively observed value, retains the coverage witness for `absent`, and
+ * omits source attribution and explanatory metadata.
+ */
+export type CatalogNameFact =
+  | {
+      state: "known";
+      value: string;
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * Compact source-free projection of [`CollectionState`]. Empty partial
+ * observations collapse to `unknown`; `absent` still requires its coverage
+ * key, and known/partial item lists cannot be empty.
+ */
+export type CatalogCollection2 =
+  | {
+      items: NonEmptyVec_MonsterRelationshipFacetV2;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_MonsterRelationshipFacetV2;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_MonsterRelationshipFacetV2 = [MonsterRelationshipFacetV2, ...MonsterRelationshipFacetV2[]];
+/**
+ * Relationship kinds represented as compact positive-count catalog facets.
+ */
+export type MonsterRelationshipFacetKind =
+  | "bans"
+  | "banMaps"
+  | "damagedBy"
+  | "attacks"
+  | "revives"
+  | "lostItems"
+  | "skillAssignments"
+  | "speakConditions"
+  | "speakGroups"
+  | "speakLines"
+  | "localizedNames"
+  | "bookEntries"
+  | "bookMaps"
+  | "questCountGroupMemberships";
+/**
+ * Compact catalog projection of [`FactState`]. It keeps the state and a
+ * positively observed value, retains the coverage witness for `absent`, and
+ * omits source attribution and explanatory metadata.
+ */
+export type CatalogFact5 =
+  | {
+      state: "known";
+      value: MediaContentId;
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+export type MediaContentId = string;
+
+/**
+ * Standalone strict Monster catalog revision 2.4.
+ */
+export interface MonsterCatalogV2_4 {
+  browseCoverage: MonsterBrowseCoverageV2_2;
+  contractVersion: "2.4";
+  format: "mapletip.monster-catalog-2";
+  recordCount: number;
+  records: MonsterCatalogRecordV2_4[];
+  scope: BuildScope;
+}
+/**
+ * Catalog-level coverage shared by every row in one build.
+ */
+export interface MonsterBrowseCoverageV2_2 {
+  /**
+   * Whether this build carries a historical drop overlay.
+   */
+  historicalDrops: "supported" | "unsupported";
+  /**
+   * Scope of every location count in this catalog.
+   */
+  locationScope: "client-placements";
+  /**
+   * Coverage witness for rows whose location state is `absent`; omitted when none exist.
+   */
+  locationsAbsentCoverageKey?: CoverageKey | null;
+  /**
+   * Coverage witness for rows whose native drop state is `absent`; omitted when none exist.
+   */
+  nativeDropsAbsentCoverageKey?: CoverageKey | null;
+}
+/**
+ * Compact Monster row for browse catalog revision 2.4.
+ */
+export interface MonsterCatalogRecordV2_4 {
+  drops: MonsterDropSummaryV2_2;
+  elements: CatalogCollection;
+  /**
+   * Present only when the same-build Map product supplies genuine geography facts.
+   */
+  geography?: MonsterGeographyV2_3 | null;
+  /**
+   * Source HP recovery value; no interval or rate is implied.
+   */
+  hpRecovery:
+    | {
+        state: "known";
+        value: SafeInt64;
+      }
+    | {
+        state: "unknown";
+      }
+    | {
+        coverageKey: CoverageKey;
+        state: "absent";
+      }
+    | {
+        state: "unsupported";
+      };
+  key: string;
+  locations: MonsterLocationSummaryV2_2;
+  /**
+   * Source MP recovery value; no interval or rate is implied.
+   */
+  mpRecovery:
+    | {
+        state: "known";
+        value: SafeInt64;
+      }
+    | {
+        state: "unknown";
+      }
+    | {
+        coverageKey: CoverageKey;
+        state: "absent";
+      }
+    | {
+        state: "unsupported";
+      };
+  name: CatalogNameFact;
+  relationships: CatalogCollection2;
+  sprite: CatalogFact5;
+  /**
+   * @minItems 12
+   * @maxItems 12
+   */
+  stats: [CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>];
+  /**
+   * @minItems 9
+   * @maxItems 9
+   */
+  traits: [CatalogFact<boolean>, CatalogFact<boolean>, CatalogFact<boolean>, CatalogFact<number>, CatalogFact<boolean>, CatalogFact<boolean>, CatalogFact<SafeInt64>, CatalogFact<SafeInt64>, CatalogFact<string>];
+}
+/**
+ * Native and historical Monster drop facts for catalog revision 2.2.
+ */
+export interface MonsterDropSummaryV2_2 {
+  /**
+   * Historical overlay evidence is present only when the build supports an overlay.
+   */
+  historical?: MonsterHistoricalDropSummaryV2_2 | null;
+  /**
+   * Native evidence from this exact build. Known counts carry an explicit
+   * lower-bound marker because Monster Book coverage is partial.
+   */
+  native:
+    | {
+        count: number;
+        lowerBound: boolean;
+        state: "known";
+      }
+    | {
+        state: "unknown";
+      }
+    | {
+        state: "absent";
+      }
+    | {
+        state: "unsupported";
+      };
+}
+/**
+ * Compact canonical and source-code summary of one element/resistance pair.
+ */
+export interface MonsterElementSummaryV2 {
+  /**
+   * Verbatim source element code.
+   */
+  code: string;
+  /**
+   * Verbatim numeric effect tier.
+   */
+  effect: number;
+  /**
+   * Canonical element meaning when the build family supports it.
+   */
+  meaning:
+    | {
+        state: "known";
+        value: string;
+      }
+    | {
+        state: "unknown";
+      }
+    | {
+        coverageKey: CoverageKey;
+        state: "absent";
+      }
+    | {
+        state: "unsupported";
+      };
+  /**
+   * Canonical damage multiplier when the build family supports it.
+   */
+  multiplier:
+    | {
+        state: "known";
+        value: number;
+      }
+    | {
+        state: "unknown";
+      }
+    | {
+        coverageKey: CoverageKey;
+        state: "absent";
+      }
+    | {
+        state: "unsupported";
+      };
+  /**
+   * Canonical resistance meaning when the build family supports it.
+   */
+  resistance:
+    | {
+        state: "known";
+        value: string;
+      }
+    | {
+        state: "unknown";
+      }
+    | {
+        coverageKey: CoverageKey;
+        state: "absent";
+      }
+    | {
+        state: "unsupported";
+      };
+}
+/**
+ * Geography filter keys collected from a Monster's resolved location entries.
+ */
+export interface MonsterGeographyV2_3 {
+  locationKeys: string[];
+  regionKeys: string[];
+  state: MonsterGeographyStateV2_3;
+}
+/**
+ * One positively observed relationship count. Zero-count tables do not
+ * appear here; the collection remains partial or unknown without a sealed
+ * source-table coverage witness.
+ */
+export interface MonsterRelationshipFacetV2 {
+  count: SafeInt64;
+  kind: MonsterRelationshipFacetKind;
+}
+/**
+ * Build scope specifying the game family and concrete build identity.
+ */
+export interface BuildScope {
+  /**
+   * Exact build identity (e.g., 'gms-v83', 'cw-cot2').
+   */
+  build_id: string;
+  /**
+   * Family identity (e.g., 'gms', 'classic-world').
+   */
+  family_id: string;
+  [k: string]: unknown | undefined;
+}