@mapletip/data 0.1.0

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

@@ -0,0 +1,366 @@
+/* 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 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;
+/**
+ * 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_ItemCatalogRecord;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: ItemCatalogRecord[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      state: "unsupported";
+    };
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_ItemCatalogRecord = [ItemCatalogRecord, ...ItemCatalogRecord[]];
+/**
+ * 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: 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";
+    };
+/**
+ * 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: 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 CatalogFact =
+  | {
+      state: "known";
+      value: string;
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+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 CatalogCollection =
+  | (
+      | {
+          items: NonEmptyVec_RelationshipSummary;
+          state: "known";
+        }
+      | {
+          items: NonEmptyVec_RelationshipSummary;
+          state: "partial";
+        }
+      | {
+          state: "unknown";
+        }
+      | {
+          coverageKey: CoverageKey;
+          state: "absent";
+        }
+      | {
+          state: "unsupported";
+        }
+    )
+  | undefined;
+/**
+ * @minItems 1
+ */
+export type NonEmptyVec_RelationshipSummary = [RelationshipSummary, ...RelationshipSummary[]];
+/**
+ * Shared collection state. `Known` is non-empty; absence requires complete
+ * source coverage and is never inferred from a missing row.
+ */
+export type CollectionState2 =
+  | {
+      items: NonEmptyVecString;
+      state: "known";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      items: string[];
+      reason: StateReason;
+      state: "partial";
+    }
+  | {
+      reason: StateReason;
+      state: "unknown";
+    }
+  | {
+      capability: Capability;
+      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: RawValue;
+    }
+  | {
+      state: "unknown";
+    }
+  | {
+      coverageKey: CoverageKey;
+      state: "absent";
+    }
+  | {
+      state: "unsupported";
+    };
+
+export interface ItemCatalog {
+  contractVersion: "2.0";
+  defaultLocale: FactState;
+  format: "item-catalog/1";
+  recordCount: FactState2;
+  records: CollectionState;
+  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;
+}
+/**
+ * Item catalog record with raw matrix values deferred to lazy evidence pages.
+ */
+export interface ItemCatalogRecord {
+  accountSharable?: FactState3 | null;
+  description?: FactState3 | null;
+  evidencePageKeys: CatalogCollection2;
+  expireOnLogout?: FactState3 | null;
+  isCash?: FactState3 | null;
+  isQuestItem?: FactState3 | null;
+  itemClass: CatalogFact;
+  itemTypeCode?: FactState3 | null;
+  key: EntityKey;
+  levelValue?: FactState3 | null;
+  maxValue?: FactState3 | null;
+  name: CatalogFact;
+  nameLocale: FactState;
+  notSale?: FactState3 | null;
+  onlyFlag?: FactState3 | null;
+  price?: FactState3 | null;
+  rateValue?: FactState3 | null;
+  recoveryHp?: FactState3 | null;
+  recoveryMp?: FactState3 | null;
+  relationships: {
+    [k: string]: CatalogCollection | undefined;
+  };
+  reqLevel?: FactState3 | null;
+  slotLimit: CatalogFact2;
+  sourceIdentity: SourceIdentity;
+  timeLimited?: FactState3 | null;
+  tradeBlocked?: FactState3 | null;
+  tradeBlockedAfterEquip?: FactState3 | null;
+  uniqueEquipped?: FactState3 | null;
+  unitPrice?: FactState3 | null;
+}
+/**
+ * A raw value and its optional source attribution.
+ */
+export interface RawValue {
+  scalar: RawScalar;
+  source?: SourceRef | null;
+}
+/**
+ * Compact count/coverage summary for a lazy relationship kind.
+ */
+export interface RelationshipSummary {
+  coverage: CollectionState2;
+  distinctTargetCount: FactState2;
+  occurrenceCount: FactState2;
+}
+/**
+ * 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;
+}