@kar-mi/spirit-vale-tools-items 0.1.9

package/README.md

@@ -0,0 +1,28 @@
+# @kar-mi/spirit-vale-tools-items
+
+Build-scoped Spirit Vale item catalog utilities.
+
+## Install
+
+```sh
+bun add @kar-mi/spirit-vale-tools-items
+```
+
+## Usage
+
+```ts
+import { loadBundledItemCatalog, resolveFishNetItem } from "@kar-mi/spirit-vale-tools-items";
+
+const catalog = loadBundledItemCatalog();
+console.log(catalog.buildFingerprint);
+
+const item = resolveFishNetItem(0, "Molten Core");
+if (item) {
+  console.log(item.displayName, item.itemType, item.effects);
+}
+```
+
+`resolveFishNetItem` returns `undefined` for unknown items; use
+`requireFishNetItem` when a missing entry should throw instead.
+
+See the [package guide](https://github.com/kar-mi/spirit-vale-tools/blob/main/docs/packages.md) for registry setup and usage.

package/dist/catalog.d.ts

@@ -0,0 +1,59 @@
+export type FishNetItemType = 0 | 1 | 2 | 3 | 4 | 5 | 6;
+export type FishNetItemSubstatGroup = "Accessory" | "Chest" | "Feet" | "Headgear" | "Legs" | "Magic" | "Melee" | "Ranged" | "Artifact";
+interface FishNetItemEffectTarget {
+    readonly kind: "element" | "skill" | "status";
+    readonly id: string;
+}
+/** A stat contribution supplied by an item's innate effect. */
+export interface FishNetItemEffect {
+    readonly type: number;
+    readonly value: number;
+    /** Optional entity named by this stat; its meaning is determined by `kind`. */
+    readonly target?: FishNetItemEffectTarget;
+}
+export interface FishNetArtifactSetEffects {
+    readonly requiredPieces: number;
+    /** Set effects applied once whenever at least one matching piece is equipped. */
+    readonly perPieceBase: readonly FishNetItemEffect[];
+    /** Set effects repeated for every matching equipped artifact. */
+    readonly perPiece: readonly FishNetItemEffect[];
+    readonly fullSet: readonly FishNetItemEffect[];
+}
+export type FishNetArtifactSlot = "Rune" | "Jewel" | "Scroll" | "Relic";
+export interface FishNetItemDefinition {
+    readonly itemType: FishNetItemType;
+    readonly id: string;
+    readonly displayName: string;
+    /** Per-item inventory weight when this item category uses a fixed weight. */
+    readonly weight?: number;
+    readonly substatGroup?: FishNetItemSubstatGroup;
+    readonly effects?: readonly FishNetItemEffect[];
+    /** Effects added once for every refine level on this item. */
+    readonly refineEffects?: readonly FishNetItemEffect[];
+    /** Set-count effects for artifact definitions. */
+    readonly artifactSet?: FishNetArtifactSetEffects;
+    /** Individual artifact effects keyed by the artifact slot they belong to. */
+    readonly artifactSlotEffects?: Partial<Record<FishNetArtifactSlot, readonly FishNetItemEffect[]>>;
+    readonly artifactSlotRefineEffects?: Partial<Record<FishNetArtifactSlot, readonly FishNetItemEffect[]>>;
+}
+export interface FishNetEquipmentItemDefinition extends FishNetItemDefinition {
+    readonly itemType: 2;
+    /** Inventory weight used by the game for one copy of this equipment item. */
+    readonly weight: number;
+}
+export interface FishNetItemCatalog {
+    readonly buildFingerprint: string;
+    readonly items: readonly FishNetItemDefinition[];
+}
+export declare function loadBundledItemCatalog(buildFingerprint?: string): FishNetItemCatalog;
+export declare class FishNetItemDirectory {
+    private readonly definitions;
+    constructor(catalog?: FishNetItemCatalog);
+    resolve(itemType: number, itemId: string | null | undefined): FishNetItemDefinition | undefined;
+    require(itemType: number, itemId: string): FishNetItemDefinition;
+}
+export declare function resolveFishNetItem(itemType: number, itemId: string | null | undefined): FishNetItemDefinition | undefined;
+export declare function resolveFishNetItemDisplayName(itemType: number, itemId: string | null | undefined): string | undefined;
+export declare function requireFishNetItem(itemType: number, itemId: string): FishNetItemDefinition;
+export {};
+//# sourceMappingURL=catalog.d.ts.map

package/dist/catalog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"catalog.d.ts","sourceRoot":"","sources":["../src/catalog.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,eAAe,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;AAExD,MAAM,MAAM,uBAAuB,GAC/B,WAAW,GACX,OAAO,GACP,MAAM,GACN,UAAU,GACV,MAAM,GACN,OAAO,GACP,OAAO,GACP,QAAQ,GACR,UAAU,CAAC;AAEf,UAAU,uBAAuB;IAC/B,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC9C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB;AAED,+DAA+D;AAC/D,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,CAAC,EAAE,uBAAuB,CAAC;CAC3C;AAED,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,iFAAiF;IACjF,QAAQ,CAAC,YAAY,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACpD,iEAAiE;IACjE,QAAQ,CAAC,QAAQ,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAChD,QAAQ,CAAC,OAAO,EAAE,SAAS,iBAAiB,EAAE,CAAC;CAChD;AAED,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,CAAC;AAExE,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,QAAQ,EAAE,eAAe,CAAC;IACnC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,6EAA6E;IAC7E,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,CAAC;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAChD,8DAA8D;IAC9D,QAAQ,CAAC,aAAa,CAAC,EAAE,SAAS,iBAAiB,EAAE,CAAC;IACtD,kDAAkD;IAClD,QAAQ,CAAC,WAAW,CAAC,EAAE,yBAAyB,CAAC;IACjD,6EAA6E;IAC7E,QAAQ,CAAC,mBAAmB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE,SAAS,iBAAiB,EAAE,CAAC,CAAC,CAAC;IAClG,QAAQ,CAAC,yBAAyB,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,mBAAmB,EAAE,SAAS,iBAAiB,EAAE,CAAC,CAAC,CAAC;CACzG;AAED,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAC3E,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;IACrB,6EAA6E;IAC7E,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,SAAS,qBAAqB,EAAE,CAAC;CAClD;AAID,wBAAgB,sBAAsB,CACpC,gBAAgB,SAAiC,GAChD,kBAAkB,CAQpB;AAED,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA4C;IAExE,YAAY,OAAO,GAAE,kBAA6C,EAQjE;IAED,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,qBAAqB,GAAG,SAAS,CAI9F;IAED,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,qBAAqB,CAI/D;CACF;AAID,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,qBAAqB,GAAG,SAAS,CAEzH;AAED,wBAAgB,6BAA6B,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAErH;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,qBAAqB,CAE1F"}