@mapletip/data 0.1.0

package/generated/quest-catalog-2.d.ts

@@ -0,0 +1,501 @@
+/* Generated automatically from Rust-owned wire definitions. Do not edit. */
+
+/**
+ * Shared fact state. SQL NULL is represented by `Unknown` with reason
+ * `source-null`; only `Absent` carries a complete-coverage witness.
+ */
+export type FactState =
+  | {
+      source?: SourceRef | null;
+      state: "known";
+      value: string;
+    }
+  | {
+      reason: StateReason;
+      source?: SourceRef | null;
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      capability: Capability;
+      source?: SourceRef | null;
+      state: "unsupported";
+    };
+export type LogicalSourceAddress = string;
+export type StateReason = string;
+export type CoverageKey = string;
+export type Capability = string;
+/**
+ * Shared collection state. `Known` is non-empty; absence requires complete
+ * source coverage and is never inferred from a missing row.
+ */
+export type CollectionState =
+  | {
+      items: NonEmptyVec_QuestLocaleCount;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: QuestLocaleCount[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestLocaleCount = [QuestLocaleCount, ...QuestLocaleCount[]];
+/**
+ * Shared fact state. SQL NULL is represented by `Unknown` with reason
+ * `source-null`; only `Absent` carries a complete-coverage witness.
+ */
+export type FactState2 =
+  | {
+      source?: SourceRef | null;
+      state: "known";
+      value: SafeInt64;
+    }
+  | {
+      reason: StateReason;
+      source?: SourceRef | null;
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      capability: Capability;
+      source?: SourceRef | null;
+      state: "unsupported";
+    };
+export type SafeInt64 = number;
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestCatalogRecord = [QuestCatalogRecord, ...QuestCatalogRecord[]];
+/**
+ * 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 CatalogFact =
+  | {
+      state: "known";
+      value: string;
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * 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 CatalogFact2 =
+  | {
+      state: "known";
+      value: TextToken[];
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * Lossless text token stream used by authored Quest text.
+ */
+export type TextToken =
+  | {
+      k: "text";
+      text: string;
+    }
+  | {
+      k: "newline";
+      raw: string;
+    }
+  | {
+      code: string;
+      k: "raw-code";
+    }
+  | {
+      code: string;
+      id: string;
+      k: "npc";
+    }
+  | {
+      code: string;
+      id: string;
+      k: "item";
+    }
+  | {
+      code: string;
+      id: string;
+      k: "monster";
+    }
+  | {
+      code: string;
+      id: string;
+      k: "map";
+    }
+  | {
+      code: string;
+      id: string;
+      k: "skill";
+    }
+  | {
+      code: string;
+      id: string;
+      k: "item-count";
+    }
+  | {
+      code: string;
+      id: string;
+      k: "item-icon";
+    }
+  | {
+      code: string;
+      id: string;
+      k: "skill-icon";
+    }
+  | {
+      k: "player-name";
+      variant?: string | null;
+    }
+  | {
+      index: string;
+      k: "choice-start";
+    }
+  | {
+      k: "choice-end";
+    }
+  | {
+      k: "progress";
+      percent: string;
+    }
+  | {
+      k: "image";
+      path: string;
+    };
+export type EntityKey = string;
+/**
+ * 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 CatalogFact3 =
+  | {
+      state: "known";
+      value: RawValue;
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * A scalar source observation that preserves the source value kind.
+ */
+export type RawScalar =
+  | {
+      kind: "integer";
+      value: SafeInt64;
+    }
+  | {
+      kind: "real";
+      value: number;
+    }
+  | {
+      kind: "text";
+      value: string;
+    }
+  | {
+      kind: "boolean";
+      value: boolean;
+    }
+  | {
+      kind: "bytes";
+      value: number[];
+    }
+  | {
+      kind: "source-null";
+    };
+/**
+ * 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 CatalogCollection3 =
+  | {
+      items: NonEmptyVec_QuestRelationCount;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_QuestRelationCount;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestRelationCount = [QuestRelationCount, ...QuestRelationCount[]];
+/**
+ * Compact relation collections exposed by the Quest catalog.
+ */
+export type QuestRelationKind = "auxiliary" | "dependencies" | "requirements" | "rewards";
+/**
+ * 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_QuestSearchTerm;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_QuestSearchTerm;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestSearchTerm = [QuestSearchTerm, ...QuestSearchTerm[]];
+/**
+ * Shared entity-reference states. The generic parameter brands resolved keys
+ * for the target domain without changing their JSON representation.
+ */
+export type EntityRef =
+  | {
+      key: EntityKey;
+      state: "resolved";
+    }
+  | {
+      sourceId: RawSourceId;
+      state: "unresolved";
+    }
+  | {
+      candidateKeys: EntityKey[];
+      state: "ambiguous";
+    }
+  | {
+      reason: StateReason;
+      state: "unavailable";
+    };
+export type RawSourceId = 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_QuestSection;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_QuestSection;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestSection = [QuestSection, ...QuestSection[]];
+/**
+ * Quest section whose source root was observed.
+ */
+export type QuestSection = "act" | "check" | "quest_info" | "say";
+
+/**
+ * Compact Quest browse index with explicit source locale dimensions and coverage.
+ */
+export interface QuestCatalog {
+  contractVersion: "2.0";
+  defaultLocale: FactState;
+  format: "mapletip.quest-catalog-2";
+  localeCounts: CollectionState;
+  recordCount: FactState2;
+  /**
+   * Sorted by exact source namespace and ID before serialization.
+   */
+  records:
+    | {
+        items: NonEmptyVec_QuestCatalogRecord;
+        state: "known";
+      }
+    | {
+        coverageKey: CoverageKey;
+        state: "absent";
+      }
+    | {
+        items: QuestCatalogRecord[];
+        reason: StateReason;
+        state: "partial";
+      }
+    | {
+        reason: StateReason;
+        state: "unknown";
+      }
+    | {
+        capability: Capability;
+        state: "unsupported";
+      };
+  scope: BuildScope;
+}
+/**
+ * Source attribution for a fact or raw observation.
+ */
+export interface SourceRef {
+  /**
+   * Optional logical address within the source; never a local file path.
+   */
+  logicalAddress?: LogicalSourceAddress | null;
+  /**
+   * Source family or source kind, preserved as supplied by the producer.
+   */
+  sourceKind: string;
+}
+/**
+ * A source-declared locale count for one Quest collection.
+ */
+export interface QuestLocaleCount {
+  collection: string;
+  count: FactState2;
+  locale: FactState;
+}
+/**
+ * One compact browse record keyed by the exact Quest source identity.
+ */
+export interface QuestCatalogRecord {
+  categoryKey: CatalogFact;
+  categoryLabel: CatalogFact;
+  demandSummary: CatalogFact;
+  demandSummaryTokens: CatalogFact2;
+  key: EntityKey;
+  name: CatalogFact;
+  nameTokens: CatalogFact2;
+  order: CatalogFact3;
+  parentName: CatalogFact;
+  parentTokens: CatalogFact2;
+  relationCounts: CatalogCollection3;
+  rewardSummary: CatalogFact;
+  rewardSummaryTokens: CatalogFact2;
+  searchTerms: CatalogCollection2;
+  sections: CatalogCollection;
+  sourceIdentity: SourceIdentity;
+  summary: CatalogFact;
+  summaryTokens: CatalogFact2;
+}
+/**
+ * A raw value and its optional source attribution.
+ */
+export interface RawValue {
+  scalar: RawScalar;
+  source?: SourceRef | null;
+}
+/**
+ * Relation collection with an observed count, retaining the exact relation kind.
+ */
+export interface QuestRelationCount {
+  count: SafeInt64;
+  kind: QuestRelationKind;
+}
+/**
+ * A presentation search term attached to its exact source field and optional resolved edge.
+ */
+export interface QuestSearchTerm {
+  fieldKey: string;
+  target?: EntityRef | null;
+  term: string;
+}
+/**
+ * Upstream source identity coordinates.
+ */
+export interface SourceIdentity {
+  /**
+   * Explicit source discriminator when one ID has multiple records (empty or omitted when unused).
+   */
+  discriminator?: string | null;
+  /**
+   * Exact upstream source identifier (e.g., '0100100').
+   */
+  id: string;
+  /**
+   * Source namespace (e.g., 'wz.mob', 'wz.item', 'wz.map'). None when missing or ambiguous.
+   */
+  namespace?: string | null;
+  [k: string]: unknown | undefined;
+}
+/**
+ * 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;
+}