@xivdyetools/types 1.2.0 → 1.3.0

package/dist/character/index.d.ts

@@ -0,0 +1,80 @@
+/**
+ * @xivdyetools/types - Character Module
+ *
+ * FFXIV character customization color type definitions.
+ * Used for matching character hair, eye, skin, and other colors to dyes.
+ *
+ * @module character
+ */
+import type { RGB, HSV } from '../color/rgb.js';
+import type { Dye } from '../dye/dye.js';
+/**
+ * A single character customization color entry
+ *
+ * Represents one color option available in the character creator,
+ * such as a specific hair color or eye color.
+ */
+export interface CharacterColor {
+    /** Index in the color palette (0-191 for most categories, 0-95 for lips) */
+    index: number;
+    /** Hex color value (#RRGGBB format) */
+    hex: string;
+    /** RGB color representation */
+    rgb: RGB;
+    /** HSV color representation (optional for compatibility) */
+    hsv?: HSV;
+}
+/**
+ * Result from matching a character color to dyes
+ */
+export interface CharacterColorMatch {
+    /** The character color that was matched */
+    characterColor: CharacterColor;
+    /** The matching dye */
+    dye: Dye;
+    /** Color distance (lower = closer match) */
+    distance: number;
+}
+/**
+ * Category of shared (race-agnostic) character colors
+ */
+export type SharedColorCategory = 'eyeColors' | 'highlightColors' | 'lipColorsDark' | 'lipColorsLight' | 'tattooColors' | 'facePaintColorsDark' | 'facePaintColorsLight';
+/**
+ * Category of race-specific character colors
+ */
+export type RaceSpecificColorCategory = 'hairColors' | 'skinColors';
+/**
+ * All character color categories
+ */
+export type CharacterColorCategory = SharedColorCategory | RaceSpecificColorCategory;
+/**
+ * FFXIV playable subraces
+ *
+ * Each race has two subraces (clans) with potentially different
+ * hair and skin color palettes.
+ */
+export type SubRace = 'Midlander' | 'Highlander' | 'Wildwood' | 'Duskwight' | 'Plainsfolk' | 'Dunesfolk' | 'SeekerOfTheSun' | 'KeeperOfTheMoon' | 'SeaWolf' | 'Hellsguard' | 'Raen' | 'Xaela' | 'Helion' | 'TheLost' | 'Rava' | 'Veena';
+/**
+ * Character gender options
+ */
+export type Gender = 'Male' | 'Female';
+/**
+ * FFXIV playable races (parent of subraces)
+ */
+export type Race = 'Hyur' | 'Elezen' | 'Lalafell' | "Miqo'te" | 'Roegadyn' | 'AuRa' | 'Hrothgar' | 'Viera';
+/**
+ * Mapping of races to their subraces
+ */
+export declare const RACE_SUBRACES: Record<Race, [SubRace, SubRace]>;
+/**
+ * Mapping of subraces to their parent race
+ */
+export declare const SUBRACE_TO_RACE: Record<SubRace, Race>;
+/**
+ * Grid dimensions for different color categories
+ */
+export declare const COLOR_GRID_DIMENSIONS: Record<CharacterColorCategory, {
+    columns: 8;
+    rows: 12 | 24;
+}>;
+//# sourceMappingURL=index.d.ts.map

package/dist/character/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/character/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AAEzC;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,4EAA4E;IAC5E,KAAK,EAAE,MAAM,CAAC;IAEd,uCAAuC;IACvC,GAAG,EAAE,MAAM,CAAC;IAEZ,+BAA+B;IAC/B,GAAG,EAAE,GAAG,CAAC;IAET,4DAA4D;IAC5D,GAAG,CAAC,EAAE,GAAG,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,cAAc,EAAE,cAAc,CAAC;IAE/B,uBAAuB;IACvB,GAAG,EAAE,GAAG,CAAC;IAET,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAC3B,WAAW,GACX,iBAAiB,GACjB,eAAe,GACf,gBAAgB,GAChB,cAAc,GACd,qBAAqB,GACrB,sBAAsB,CAAC;AAE3B;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,YAAY,GAAG,YAAY,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAC9B,mBAAmB,GACnB,yBAAyB,CAAC;AAE9B;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAEf,WAAW,GACX,YAAY,GAEZ,UAAU,GACV,WAAW,GAEX,YAAY,GACZ,WAAW,GAEX,gBAAgB,GAChB,iBAAiB,GAEjB,SAAS,GACT,YAAY,GAEZ,MAAM,GACN,OAAO,GAEP,QAAQ,GACR,SAAS,GAET,MAAM,GACN,OAAO,CAAC;AAEZ;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG,MAAM,GAAG,QAAQ,CAAC;AAEvC;;GAEG;AACH,MAAM,MAAM,IAAI,GACZ,MAAM,GACN,QAAQ,GACR,UAAU,GACV,SAAS,GACT,UAAU,GACV,MAAM,GACN,UAAU,GACV,OAAO,CAAC;AAEZ;;GAEG;AACH,eAAO,MAAM,aAAa,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAS1D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,eAAe,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,CAiBjD,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,qBAAqB,EAAE,MAAM,CACxC,sBAAsB,EACtB;IAAE,OAAO,EAAE,CAAC,CAAC;IAAC,IAAI,EAAE,EAAE,GAAG,EAAE,CAAA;CAAE,CAW9B,CAAC"}

package/dist/character/index.js

@@ -0,0 +1,57 @@
+/**
+ * @xivdyetools/types - Character Module
+ *
+ * FFXIV character customization color type definitions.
+ * Used for matching character hair, eye, skin, and other colors to dyes.
+ *
+ * @module character
+ */
+/**
+ * Mapping of races to their subraces
+ */
+export const RACE_SUBRACES = {
+    Hyur: ['Midlander', 'Highlander'],
+    Elezen: ['Wildwood', 'Duskwight'],
+    Lalafell: ['Plainsfolk', 'Dunesfolk'],
+    "Miqo'te": ['SeekerOfTheSun', 'KeeperOfTheMoon'],
+    Roegadyn: ['SeaWolf', 'Hellsguard'],
+    AuRa: ['Raen', 'Xaela'],
+    Hrothgar: ['Helion', 'TheLost'],
+    Viera: ['Rava', 'Veena'],
+};
+/**
+ * Mapping of subraces to their parent race
+ */
+export const SUBRACE_TO_RACE = {
+    Midlander: 'Hyur',
+    Highlander: 'Hyur',
+    Wildwood: 'Elezen',
+    Duskwight: 'Elezen',
+    Plainsfolk: 'Lalafell',
+    Dunesfolk: 'Lalafell',
+    SeekerOfTheSun: "Miqo'te",
+    KeeperOfTheMoon: "Miqo'te",
+    SeaWolf: 'Roegadyn',
+    Hellsguard: 'Roegadyn',
+    Raen: 'AuRa',
+    Xaela: 'AuRa',
+    Helion: 'Hrothgar',
+    TheLost: 'Hrothgar',
+    Rava: 'Viera',
+    Veena: 'Viera',
+};
+/**
+ * Grid dimensions for different color categories
+ */
+export const COLOR_GRID_DIMENSIONS = {
+    eyeColors: { columns: 8, rows: 24 },
+    highlightColors: { columns: 8, rows: 24 },
+    lipColorsDark: { columns: 8, rows: 12 },
+    lipColorsLight: { columns: 8, rows: 12 },
+    tattooColors: { columns: 8, rows: 24 },
+    facePaintColorsDark: { columns: 8, rows: 24 },
+    facePaintColorsLight: { columns: 8, rows: 24 },
+    hairColors: { columns: 8, rows: 24 },
+    skinColors: { columns: 8, rows: 24 },
+};
+//# sourceMappingURL=index.js.map

package/dist/character/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/character/index.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAiHH;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAqC;IAC7D,IAAI,EAAE,CAAC,WAAW,EAAE,YAAY,CAAC;IACjC,MAAM,EAAE,CAAC,UAAU,EAAE,WAAW,CAAC;IACjC,QAAQ,EAAE,CAAC,YAAY,EAAE,WAAW,CAAC;IACrC,SAAS,EAAE,CAAC,gBAAgB,EAAE,iBAAiB,CAAC;IAChD,QAAQ,EAAE,CAAC,SAAS,EAAE,YAAY,CAAC;IACnC,IAAI,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IACvB,QAAQ,EAAE,CAAC,QAAQ,EAAE,SAAS,CAAC;IAC/B,KAAK,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,eAAe,GAA0B;IACpD,SAAS,EAAE,MAAM;IACjB,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,QAAQ;IAClB,SAAS,EAAE,QAAQ;IACnB,UAAU,EAAE,UAAU;IACtB,SAAS,EAAE,UAAU;IACrB,cAAc,EAAE,SAAS;IACzB,eAAe,EAAE,SAAS;IAC1B,OAAO,EAAE,UAAU;IACnB,UAAU,EAAE,UAAU;IACtB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,UAAU;IAClB,OAAO,EAAE,UAAU;IACnB,IAAI,EAAE,OAAO;IACb,KAAK,EAAE,OAAO;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAG9B;IACF,SAAS,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACnC,eAAe,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACzC,aAAa,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACvC,cAAc,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACxC,YAAY,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACtC,mBAAmB,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IAC7C,oBAAoB,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IAC9C,UAAU,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;IACpC,UAAU,EAAE,EAAE,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE;CACrC,CAAC"}

package/dist/index.d.ts

@@ -17,6 +17,8 @@ export type { HexColor, DyeId, Hue, Saturation } from './color/index.js';
 export { createHexColor, createDyeId, createHue, createSaturation } from './color/index.js';
 export type { VisionType, Matrix3x3, ColorblindMatrices } from './color/index.js';
 export type { Dye, LocalizedDye, DyeWithDistance, DyeDatabase } from './dye/index.js';
+export type { CharacterColor, CharacterColorMatch, SharedColorCategory, RaceSpecificColorCategory, CharacterColorCategory, SubRace, Gender, Race, } from './character/index.js';
+export { RACE_SUBRACES, SUBRACE_TO_RACE, COLOR_GRID_DIMENSIONS, } from './character/index.js';
 export type { PresetCategory, PresetStatus, PresetSortOption, CategoryMeta, PresetPalette, ResolvedPreset, PresetData, PresetPreviousValues, CommunityPreset, PresetSubmission, AuthenticatedPresetSubmission, PresetFilters, PresetEditRequest, PresetListResponse, PresetSubmitResponse, PresetEditResponse, VoteResponse, ModerationResponse, CategoryListResponse, } from './preset/index.js';
 export type { AuthProvider, AuthSource, AuthContext, PrimaryCharacter, JWTPayload, OAuthState, DiscordTokenResponse, DiscordUser, XIVAuthTokenResponse, XIVAuthCharacter, XIVAuthCharacterRegistration, XIVAuthSocialIdentity, XIVAuthUser, AuthUser, AuthResponse, RefreshResponse, UserInfoResponse, } from './auth/index.js';
 export type { APIResponse, CachedData, ModerationResult, ModerationLogEntry, ModerationStats, PriceData, RateLimitResult, } from './api/index.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAKH,YAAY,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACjD,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC5F,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAKlF,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAKtF,YAAY,EACV,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,UAAU,EACV,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,6BAA6B,EAC7B,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAK3B,YAAY,EACV,YAAY,EACZ,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,oBAAoB,EACpB,WAAW,EACX,oBAAoB,EACpB,gBAAgB,EAChB,4BAA4B,EAC5B,qBAAqB,EACrB,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,eAAe,EACf,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAKzB,YAAY,EACV,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,SAAS,EACT,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAKxB,YAAY,EACV,UAAU,EACV,cAAc,EACd,cAAc,EACd,MAAM,EACN,eAAe,EACf,UAAU,EACV,gBAAgB,GACjB,MAAM,yBAAyB,CAAC;AAKjC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAKtD,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAKH,YAAY,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,kBAAkB,CAAC;AACjD,YAAY,EAAE,QAAQ,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAC5F,YAAY,EAAE,UAAU,EAAE,SAAS,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAKlF,YAAY,EAAE,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAKtF,YAAY,EACV,cAAc,EACd,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,sBAAsB,EACtB,OAAO,EACP,MAAM,EACN,IAAI,GACL,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,aAAa,EACb,eAAe,EACf,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AAK9B,YAAY,EACV,cAAc,EACd,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,UAAU,EACV,oBAAoB,EACpB,eAAe,EACf,gBAAgB,EAChB,6BAA6B,EAC7B,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,kBAAkB,EAClB,YAAY,EACZ,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,mBAAmB,CAAC;AAK3B,YAAY,EACV,YAAY,EACZ,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,UAAU,EACV,oBAAoB,EACpB,WAAW,EACX,oBAAoB,EACpB,gBAAgB,EAChB,4BAA4B,EAC5B,qBAAqB,EACrB,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,eAAe,EACf,gBAAgB,GACjB,MAAM,iBAAiB,CAAC;AAKzB,YAAY,EACV,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,SAAS,EACT,eAAe,GAChB,MAAM,gBAAgB,CAAC;AAKxB,YAAY,EACV,UAAU,EACV,cAAc,EACd,cAAc,EACd,MAAM,EACN,eAAe,EACf,UAAU,EACV,gBAAgB,GACjB,MAAM,yBAAyB,CAAC;AAKjC,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,YAAY,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAKtD,YAAY,EAAE,MAAM,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAClF,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC"}

package/dist/index.js

@@ -13,6 +13,7 @@
  * @packageDocumentation
  */
 export { createHexColor, createDyeId, createHue, createSaturation } from './color/index.js';
+export { RACE_SUBRACES, SUBRACE_TO_RACE, COLOR_GRID_DIMENSIONS, } from './character/index.js';
 // ============================================================================
 // Error Types
 // ============================================================================

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAOH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAkF5F,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAO5C,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAOH,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAqB5F,OAAO,EACL,aAAa,EACb,eAAe,EACf,qBAAqB,GACtB,MAAM,sBAAsB,CAAC;AA4E9B,+EAA+E;AAC/E,cAAc;AACd,+EAA+E;AAC/E,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAO5C,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xivdyetools/types",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Shared TypeScript type definitions for the xivdyetools ecosystem",
   "author": "XIV Dye Tools",
   "license": "MIT",
@@ -20,6 +20,10 @@
       "types": "./dist/dye/index.d.ts",
       "import": "./dist/dye/index.js"
     },
+    "./character": {
+      "types": "./dist/character/index.d.ts",
+      "import": "./dist/character/index.js"
+    },
     "./preset": {
       "types": "./dist/preset/index.d.ts",
       "import": "./dist/preset/index.js"