@xivdyetools/types 1.1.1 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -94,6 +94,7 @@ import { Dye, LocalizedDye, DyeWithDistance, DyeDatabase } from '@xivdyetools/ty
94
94
  // Full dye object
95
95
  const dye: Dye = {
96
96
  itemID: 5729,
97
+ stainID: 1, // Game's internal stain table ID (null for Facewear dyes)
97
98
  id: 1,
98
99
  name: 'Snow White',
99
100
  hex: '#FFFFFF',
@@ -267,6 +268,20 @@ import { CommunityPreset, PresetFilters, ModerationResult } from '@xivdyetools/t
267
268
  | `isOk(result)` | Type guard for successful Result |
268
269
  | `isErr(result)` | Type guard for error Result |
269
270
 
271
+ ## Connect With Me
272
+
273
+ **Flash Galatine** | Balmung (Crystal)
274
+
275
+ 🎮 **FFXIV**: [Lodestone Character](https://na.finalfantasyxiv.com/lodestone/character/7677106/)
276
+ 📝 **Blog**: [Project Galatine](https://blog.projectgalatine.com/)
277
+ 💻 **GitHub**: [@FlashGalatine](https://github.com/FlashGalatine)
278
+ 🐦 **X / Twitter**: [@AsheJunius](https://x.com/AsheJunius)
279
+ 📺 **Twitch**: [flashgalatine](https://www.twitch.tv/flashgalatine)
280
+ 🌐 **BlueSky**: [projectgalatine.com](https://bsky.app/profile/projectgalatine.com)
281
+ ❤️ **Patreon**: [ProjectGalatine](https://patreon.com/ProjectGalatine)
282
+ ☕ **Ko-Fi**: [flashgalatine](https://ko-fi.com/flashgalatine)
283
+ 💬 **Discord**: [Join Server](https://discord.gg/5VUSKTZCe5)
284
+
270
285
  ## License
271
286
 
272
- MIT
287
+ MIT © 2025 Flash Galatine
package/dist/dye/dye.d.ts CHANGED
@@ -24,6 +24,21 @@ import type { RGB, HSV } from '../color/rgb.js';
24
24
  export interface Dye {
25
25
  /** FFXIV item ID */
26
26
  itemID: number;
27
+ /**
28
+ * Game's internal stain table ID (1-125).
29
+ *
30
+ * This is the ID used in the game's Stain Excel table and by plugins
31
+ * like Glamourer and Mare Synchronos. Unlike itemID, stainID may shift
32
+ * when new dyes are added to the game.
33
+ *
34
+ * **Note:** Facewear dyes do not have stainIDs (null).
35
+ *
36
+ * **Recommendation:** Use `itemID` for stable references. Use `stainID`
37
+ * only when interfacing with plugins or datamined content.
38
+ *
39
+ * @since 2.1.0
40
+ */
41
+ stainID: number | null;
27
42
  /** Unique dye ID (1-200) */
28
43
  id: number;
29
44
  /** English dye name */
@@ -1 +1 @@
1
- {"version":3,"file":"dye.d.ts","sourceRoot":"","sources":["../../src/dye/dye.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,WAAW,GAAG;IAClB,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IAEf,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,uCAAuC;IACvC,GAAG,EAAE,MAAM,CAAC;IAEZ,+BAA+B;IAC/B,GAAG,EAAE,GAAG,CAAC;IAET,+BAA+B;IAC/B,GAAG,EAAE,GAAG,CAAC;IAET,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC;IAEjB,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAC;IAEpB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IAEH,qCAAqC;IACrC,UAAU,EAAE,OAAO,CAAC;IAEpB,mCAAmC;IACnC,QAAQ,EAAE,OAAO,CAAC;IAElB,uCAAuC;IACvC,MAAM,EAAE,OAAO,CAAC;IAEhB,wDAAwD;IACxD,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,GAAG;IACvC,yCAAyC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,GAAG;IAC1C,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;CAClB"}
1
+ {"version":3,"file":"dye.d.ts","sourceRoot":"","sources":["../../src/dye/dye.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,WAAW,GAAG;IAClB,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;OAaG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAC;IAEX,uBAAuB;IACvB,IAAI,EAAE,MAAM,CAAC;IAEb,uCAAuC;IACvC,GAAG,EAAE,MAAM,CAAC;IAEZ,+BAA+B;IAC/B,GAAG,EAAE,GAAG,CAAC;IAET,+BAA+B;IAC/B,GAAG,EAAE,GAAG,CAAC;IAET,qDAAqD;IACrD,QAAQ,EAAE,MAAM,CAAC;IAEjB,oEAAoE;IACpE,WAAW,EAAE,MAAM,CAAC;IAEpB,sCAAsC;IACtC,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IAEH,qCAAqC;IACrC,UAAU,EAAE,OAAO,CAAC;IAEpB,mCAAmC;IACnC,QAAQ,EAAE,OAAO,CAAC;IAElB,uCAAuC;IACvC,MAAM,EAAE,OAAO,CAAC;IAEhB,wDAAwD;IACxD,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,GAAG;IACvC,yCAAyC;IACzC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,GAAG;IAC1C,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;CAClB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xivdyetools/types",
3
- "version": "1.1.1",
3
+ "version": "1.2.0",
4
4
  "description": "Shared TypeScript type definitions for the xivdyetools ecosystem",
5
5
  "author": "XIV Dye Tools",
6
6
  "license": "MIT",