@mapletip/data 0.1.0

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

@@ -0,0 +1,868 @@
+/* Generated automatically from Rust-owned wire definitions. Do not edit. */
+
+/**
+ * Shared collection state. `Known` is non-empty; absence requires complete
+ * source coverage and is never inferred from a missing row.
+ */
+export type CollectionState8 =
+  | {
+      items: NonEmptyVec_QuestDialogueLine;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: QuestDialogueLine[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestDialogueLine = [QuestDialogueLine, ...QuestDialogueLine[]];
+/**
+ * Shared fact state. SQL NULL is represented by `Unknown` with reason
+ * `source-null`; only `Absent` carries a complete-coverage witness.
+ */
+export type FactState3 =
+  | {
+      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 fact state. SQL NULL is represented by `Unknown` with reason
+ * `source-null`; only `Absent` carries a complete-coverage witness.
+ */
+export type FactState5 =
+  | {
+      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;
+/**
+ * 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: QuestPhase;
+    }
+  | {
+      reason: StateReason;
+      source?: SourceRef | null;
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      capability: Capability;
+      source?: SourceRef | null;
+      state: "unsupported";
+    };
+/**
+ * Literal Quest state-key phase. Unknown keys remain `FactState::Unknown`.
+ */
+export type QuestPhase = "start" | "complete";
+/**
+ * Shared fact state. SQL NULL is represented by `Unknown` with reason
+ * `source-null`; only `Absent` carries a complete-coverage witness.
+ */
+export type FactState4 =
+  | {
+      source?: SourceRef | null;
+      state: "known";
+      value: TextToken[];
+    }
+  | {
+      reason: StateReason;
+      source?: SourceRef | null;
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      capability: Capability;
+      source?: SourceRef | null;
+      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;
+    };
+/**
+ * Shared collection state. `Known` is non-empty; absence requires complete
+ * source coverage and is never inferred from a missing row.
+ */
+export type CollectionState7 =
+  | {
+      items: NonEmptyVec_QuestLocalizedText;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: QuestLocalizedText[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestLocalizedText = [QuestLocalizedText, ...QuestLocalizedText[]];
+export type EntityKey = string;
+/**
+ * Shared collection state. `Known` is non-empty; absence requires complete
+ * source coverage and is never inferred from a missing row.
+ */
+export type CollectionState5 =
+  | {
+      items: NonEmptyVec_QuestAuxiliaryOccurrence;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: QuestAuxiliaryOccurrence[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestAuxiliaryOccurrence = [QuestAuxiliaryOccurrence, ...QuestAuxiliaryOccurrence[]];
+/**
+ * Auxiliary Quest relationship payload, tagged by its observed source collection.
+ *
+ * Large variants intentionally mirror the approved wire shape. Indirection
+ * would not reduce serialized size and would make construction less direct.
+ */
+export type QuestAuxiliaryKind =
+  | {
+      kind: "category";
+      value: {
+        categoryKey: FactState3;
+        categoryLabel: FactState3;
+      };
+    }
+  | {
+      kind: "cot2-extra";
+      value: {
+        destination?: EntityRef3 | null;
+        destinationCoverage: FactState2;
+        destinationTypedVersion: FactState2;
+        expByLevel: FactState2;
+        performByDay: FactState2;
+        quest?: EntityRef | null;
+        questCoverage: FactState2;
+        questTypedVersion: FactState2;
+      };
+    }
+  | {
+      kind: "exclusive";
+      value: {
+        groupKey: string;
+        ordinal: SafeInt64;
+        target: EntityRef;
+        targetCoverage: FactState2;
+        targetTypedVersion: FactState2;
+      };
+    }
+  | {
+      kind: "party-rank";
+      value: {
+        rankValue: FactState2;
+      };
+    }
+  | {
+      kind: "recurring-definition";
+      value: {
+        groupKey: FactState2;
+        infoText: FactState3;
+        recurrenceType: FactState2;
+      };
+    }
+  | {
+      kind: "recurring-member";
+      value: {
+        /**
+         * Shared fact state. SQL NULL is represented by `Unknown` with reason
+         * `source-null`; only `Absent` carries a complete-coverage witness.
+         */
+        container:
+          | {
+              source?: SourceRef | null;
+              state: "known";
+              value: RawValue;
+            }
+          | {
+              reason: StateReason;
+              source?: SourceRef | null;
+              state: "unknown";
+            }
+          | {
+              coverageKey: CoverageKey;
+              state: "absent";
+            }
+          | {
+              capability: Capability;
+              source?: SourceRef | null;
+              state: "unsupported";
+            };
+        groupKey: string;
+        ordinal: SafeInt64;
+        target: EntityRef;
+        targetCoverage: FactState2;
+        targetTypedVersion: FactState2;
+      };
+    };
+/**
+ * Shared entity-reference states. The generic parameter brands resolved keys
+ * for the target domain without changing their JSON representation.
+ */
+export type EntityRef3 =
+  | {
+      key: EntityKey;
+      state: "resolved";
+    }
+  | {
+      sourceId: RawSourceId;
+      state: "unresolved";
+    }
+  | {
+      candidateKeys: EntityKey[];
+      state: "ambiguous";
+    }
+  | {
+      reason: StateReason;
+      state: "unavailable";
+    };
+export type RawSourceId = string;
+/**
+ * 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: RawValue;
+    }
+  | {
+      reason: StateReason;
+      source?: SourceRef | null;
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      capability: Capability;
+      source?: SourceRef | null;
+      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";
+    };
+/**
+ * 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";
+    };
+/**
+ * Shared collection state. `Known` is non-empty; absence requires complete
+ * source coverage and is never inferred from a missing row.
+ */
+export type CollectionState4 =
+  | {
+      items: NonEmptyVec_QuestDependencyRecord;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: QuestDependencyRecord[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestDependencyRecord = [QuestDependencyRecord, ...QuestDependencyRecord[]];
+/**
+ * Direction of a Quest dependency projection relative to the record that carries it.
+ */
+export type QuestDependencyDirection = "forward" | "reverse";
+/**
+ * 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_QuestRequirementRecord;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: QuestRequirementRecord[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestRequirementRecord = [QuestRequirementRecord, ...QuestRequirementRecord[]];
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestMonsterCountGroupMember = [
+  QuestMonsterCountGroupMember,
+  ...QuestMonsterCountGroupMember[]
+];
+/**
+ * Shared entity-reference states. The generic parameter brands resolved keys
+ * for the target domain without changing their JSON representation.
+ */
+export type EntityRef2 =
+  | {
+      key: EntityKey;
+      state: "resolved";
+    }
+  | {
+      sourceId: RawSourceId;
+      state: "unresolved";
+    }
+  | {
+      candidateKeys: EntityKey[];
+      state: "ambiguous";
+    }
+  | {
+      reason: StateReason;
+      state: "unavailable";
+    };
+/**
+ * Shared collection state. `Known` is non-empty; absence requires complete
+ * source coverage and is never inferred from a missing row.
+ */
+export type CollectionState3 =
+  | {
+      items: NonEmptyVec_QuestRewardRecord;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: QuestRewardRecord[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestRewardRecord = [QuestRewardRecord, ...QuestRewardRecord[]];
+/**
+ * Shared collection state. `Known` is non-empty; absence requires complete
+ * source coverage and is never inferred from a missing row.
+ */
+export type CollectionState6 =
+  | {
+      items: NonEmptyVec_QuestStateText;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: QuestStateText[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_QuestStateText = [QuestStateText, ...QuestStateText[]];
+
+/**
+ * Bounded pack of Quest relationship records keyed by stable record key.
+ */
+export interface QuestRelationshipPack {
+  contractVersion: "2.0";
+  format: "mapletip.quest-relationship-pack-2";
+  records: {
+    [k: string]: QuestRelationshipRecord | undefined;
+  };
+  scope: BuildScope;
+}
+/**
+ * One relationship page for one exact Quest owner.
+ */
+export interface QuestRelationshipRecord {
+  dialogue: CollectionState8;
+  localizedTexts: CollectionState7;
+  ownerKey: EntityKey;
+  recordKey: string;
+  relationships: QuestRelationships;
+  stateTexts: CollectionState6;
+}
+/**
+ * One authored Quest dialogue line; source paths remain evidence references.
+ */
+export interface QuestDialogueLine {
+  evidenceKey: string;
+  locale: FactState3;
+  occurrenceKey: string;
+  ordinal: FactState5;
+  phase: FactState;
+  sourceOrdinal: FactState5;
+  stateKey: SafeInt64;
+  text: FactState3;
+  tokens: FactState4;
+}
+/**
+ * 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;
+}
+/**
+ * Locale-keyed authored Quest text.
+ */
+export interface QuestLocalizedText {
+  fieldKey: FactState3;
+  locale: FactState3;
+  occurrenceKey: string;
+  text: FactState3;
+  tokens: FactState4;
+}
+/**
+ * Collection pages owned by one canonical Quest source relationship.
+ */
+export interface QuestRelationships {
+  auxiliary: CollectionState5;
+  dependencies: CollectionState4;
+  requirements: CollectionState;
+  rewards: CollectionState3;
+}
+/**
+ * One auxiliary relationship occurrence.
+ */
+export interface QuestAuxiliaryOccurrence {
+  evidenceKey: string;
+  occurrenceKey: string;
+  value: QuestAuxiliaryKind;
+}
+/**
+ * A raw value and its optional source attribution.
+ */
+export interface RawValue {
+  scalar: RawScalar;
+  source?: SourceRef | null;
+}
+/**
+ * Projection of a Quest-to-Quest requirement or reward occurrence (ruling 3.2-R7).
+ *
+ * A dependency is never a new source observation: its `occurrence_key` and `evidence_key` are
+ * those of the requirement/reward record it projects, and no source value is copied. A forward
+ * record sits on the owner Quest; a reverse record sits on the resolved target Quest and exists
+ * only when the target resolves to a Quest of the same build. `target` names the counterpart
+ * Quest: the canonical edge target on a forward record, the owner on a reverse record.
+ * `target_coverage` and `target_typed_version` describe the target of the canonical edge and are
+ * identical on both directions.
+ */
+export interface QuestDependencyRecord {
+  direction: QuestDependencyDirection;
+  evidenceKey: string;
+  occurrenceKey: string;
+  relationKind: FactState2;
+  target: EntityRef;
+  targetCoverage: FactState2;
+  targetTypedVersion: FactState2;
+}
+/**
+ * Canonical Quest-owned requirement occurrence.
+ */
+export interface QuestRequirementRecord {
+  evidenceKey: string;
+  kind: FactState2;
+  occurrenceKey: string;
+  ordinal: SafeInt64;
+  phase: FactState;
+  stateKey: SafeInt64;
+  target?: EntityRef;
+  targetCoverage?: FactState2;
+  targetKind?: FactState2;
+  targetTypedVersion?: FactState2;
+  value: QuestRequirementValue;
+}
+/**
+ * Raw-neutral values retained on a Quest requirement occurrence.
+ */
+export interface QuestRequirementValue {
+  acquireFlag?: FactState2;
+  amount?: FactState2;
+  conditionText?: FactState2;
+  levelCondition?: FactState2;
+  maxValue?: FactState2;
+  minValue?: FactState2;
+  mobKill?: QuestRequirementMobKillValue;
+  orderValue?: FactState2;
+  scriptName?: FactState2;
+  stateValue?: FactState2;
+  textValue?: FactState2;
+}
+/**
+ * Count-group source evidence on a mob-kill requirement.
+ */
+export interface QuestRequirementMobKillValue {
+  /**
+   * Present only for a resolved count group; absent and known-empty remain distinct.
+   */
+  countGroupMembers?:
+    | {
+        items: NonEmptyVec_QuestMonsterCountGroupMember;
+        state: "known";
+      }
+    | {
+        coverageKey: CoverageKey;
+        state: "absent";
+      }
+    | {
+        items: QuestMonsterCountGroupMember[];
+        reason: StateReason;
+        state: "partial";
+      }
+    | {
+        reason: StateReason;
+        state: "unknown";
+      }
+    | {
+        capability: Capability;
+        state: "unsupported";
+      };
+  /**
+   * Shared fact state. SQL NULL is represented by `Unknown` with reason
+   * `source-null`; only `Absent` carries a complete-coverage witness.
+   */
+  countGroupSourceId:
+    | {
+        source?: SourceRef | null;
+        state: "known";
+        value: RawValue;
+      }
+    | {
+        reason: StateReason;
+        source?: SourceRef | null;
+        state: "unknown";
+      }
+    | {
+        coverageKey: CoverageKey;
+        state: "absent";
+      }
+    | {
+        capability: Capability;
+        source?: SourceRef | null;
+        state: "unsupported";
+      };
+}
+/**
+ * One Monster occurrence projected from a Quest count-group observation.
+ */
+export interface QuestMonsterCountGroupMember {
+  memberOrdinal: SafeInt64;
+  occurrenceKey: string;
+  sourceId: FactState2;
+  target: EntityRef2;
+}
+/**
+ * Canonical Quest-owned reward occurrence.
+ */
+export interface QuestRewardRecord {
+  evidenceKey: string;
+  kind: FactState2;
+  occurrenceKey: string;
+  ordinal: SafeInt64;
+  phase: FactState;
+  stateKey: SafeInt64;
+  target?: EntityRef;
+  targetCoverage?: FactState2;
+  targetKind?: FactState2;
+  targetTypedVersion?: FactState2;
+  value: QuestRewardValue;
+}
+/**
+ * Raw-neutral values retained on a Quest reward occurrence.
+ */
+export interface QuestRewardValue {
+  acquireFlag?: FactState2;
+  amount?: FactState2;
+  dateExpire?: FactState2;
+  gender?: FactState2;
+  grantMode?: FactState2;
+  grantWeight?: FactState2;
+  itemEffect?: FactState2;
+  itemQuantity?: FactState2;
+  jobMask?: FactState2;
+  masterLevel?: FactState2;
+  nameOverride?: FactState2;
+  onlyMasterLevel?: FactState2;
+  orderValue?: FactState2;
+  period?: FactState2;
+  potentialGrade?: FactState2;
+  prob?: FactState2;
+  skillLevel?: FactState2;
+  stateValue?: FactState2;
+  textValue?: FactState2;
+  varValue?: FactState2;
+}
+/**
+ * Authored Quest state text at one literal source key.
+ */
+export interface QuestStateText {
+  locale: FactState3;
+  occurrenceKey: string;
+  stateKey: SafeInt64;
+  text: FactState3;
+  tokens: FactState4;
+}
+/**
+ * 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;
+}