@mapletip/data 0.1.0

package/generated/quest-browse-pack-2.d.ts

@@ -0,0 +1,353 @@
+/* Generated automatically from Rust-owned wire definitions. Do not edit. */
+
+/**
+ * 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: boolean;
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+export type CoverageKey = 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 CatalogFact2 =
+  | {
+      state: "known";
+      value: QuestBrowseEventWindow;
+    }
+  | {
+      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 CatalogCollection =
+  | {
+      items: NonEmptyVec_SafeInt64;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_SafeInt64;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_SafeInt64 = [SafeInt64, ...SafeInt64[]];
+export type SafeInt64 = number;
+export type EntityKey = 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 CatalogCollection3 =
+  | {
+      items: NonEmptyVec_QuestBrowseObjective;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_QuestBrowseObjective;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestBrowseObjective = [QuestBrowseObjective, ...QuestBrowseObjective[]];
+/**
+ * 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_QuestBrowseRecurrence;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_QuestBrowseRecurrence;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestBrowseRecurrence = [QuestBrowseRecurrence, ...QuestBrowseRecurrence[]];
+/**
+ * Authored recurrence rule on a Quest.
+ */
+export type QuestBrowseRecurrence =
+  | {
+      kind: "interval";
+      minutes: SafeInt64;
+    }
+  | {
+      kind: "day-by-day";
+    }
+  | {
+      kind: "weekly-repeat";
+    }
+  | {
+      day?: string | null;
+      kind: "day-of-week";
+    };
+/**
+ * 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: SafeInt64;
+    }
+  | {
+      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 CatalogCollection4 =
+  | {
+      items: NonEmptyVec_QuestBrowseItemReward;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVec_QuestBrowseItemReward;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestBrowseItemReward = [QuestBrowseItemReward, ...QuestBrowseItemReward[]];
+/**
+ * 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;
+export type StateReason = 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 CatalogCollection5 =
+  | {
+      items: NonEmptyVecString;
+      state: "known";
+    }
+  | {
+      items: NonEmptyVecString;
+      state: "partial";
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVecString = [string, ...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 CatalogFact4 =
+  | {
+      state: "known";
+      value: string;
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+
+/**
+ * Bounded pack of compact Quest browse records keyed by Quest entity key.
+ */
+export interface QuestBrowsePack {
+  contractVersion: "2.1";
+  format: "mapletip.quest-browse-pack-2";
+  records: {
+    [k: string]: QuestBrowseRecord | undefined;
+  };
+  scope: BuildScope;
+}
+/**
+ * Compact Quest browse record carrying source facts for browse and filtering.
+ */
+export interface QuestBrowseRecord {
+  autoStart: CatalogFact3;
+  eventWindow: CatalogFact2;
+  jobCodes: CatalogCollection;
+  key: EntityKey;
+  objectives: CatalogCollection3;
+  recurrence: CatalogCollection2;
+  rewards: QuestBrowseRewards;
+  specialConditions: CatalogFact;
+  startLevelMax: CatalogFact;
+  startLevelMin: CatalogFact;
+  startNpc: CatalogFact4;
+  turnInNpc: CatalogFact4;
+}
+/**
+ * Authored event window on a Quest.
+ */
+export interface QuestBrowseEventWindow {
+  endDate?: string | null;
+  startDate?: string | null;
+}
+/**
+ * Complete-phase objective requirement in source order.
+ */
+export interface QuestBrowseObjective {
+  kind: string;
+  quantity?: SafeInt64 | null;
+  targets?: string[];
+}
+/**
+ * Complete-phase rewards summary for Quest browse facets.
+ */
+export interface QuestBrowseRewards {
+  exp: CatalogFact;
+  fame: CatalogFact;
+  hasActSection: CatalogFact3;
+  items: CatalogCollection4;
+  mesos: CatalogFact;
+  otherRewardCount: CatalogFact;
+  skills: CatalogCollection5;
+}
+/**
+ * Complete-phase item reward occurrence.
+ */
+export interface QuestBrowseItemReward {
+  effect?: string | null;
+  eligibility?: QuestBrowseRewardEligibility | null;
+  grantMode?: string | null;
+  quantity?: SafeInt64 | null;
+  target: EntityRef;
+}
+/**
+ * Authored eligibility constraints on a Quest item reward.
+ */
+export interface QuestBrowseRewardEligibility {
+  gender?: SafeInt64 | null;
+  jobMask?: SafeInt64 | null;
+}
+/**
+ * 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;
+}