@ffxiark/character-viewer 0.0.1

package/dist/lighting-Bn1ftR_s.d.ts

@@ -0,0 +1,145 @@
+declare const RACE_GENDER_CONFIGS: readonly [{
+    readonly name: "HumeM";
+    readonly index: 1;
+}, {
+    readonly name: "HumeF";
+    readonly index: 2;
+}, {
+    readonly name: "ElvaanM";
+    readonly index: 3;
+}, {
+    readonly name: "ElvaanF";
+    readonly index: 4;
+}, {
+    readonly name: "TaruM";
+    readonly index: 5;
+}, {
+    readonly name: "TaruF";
+    readonly index: 6;
+}, {
+    readonly name: "Mithra";
+    readonly index: 7;
+}, {
+    readonly name: "Galka";
+    readonly index: 8;
+}];
+type RaceGenderName = (typeof RACE_GENDER_CONFIGS)[number]["name"];
+declare const ITEM_MODEL_SLOTS: readonly ["Face", "Head", "Body", "Hands", "Legs", "Feet", "Main", "Sub", "Range"];
+type ItemModelSlotName = (typeof ITEM_MODEL_SLOTS)[number];
+interface CharacterItemLook {
+    race: RaceGenderName;
+    face: number;
+    items: Partial<Record<ItemModelSlotName, number>>;
+}
+
+/** Armor + weapon visual slots used at render time (flat appearance API). */
+declare const MODEL_SLOT_IDS: readonly ["head", "body", "hands", "legs", "feet", "main", "sub", "range"];
+type ModelSlotId = (typeof MODEL_SLOT_IDS)[number];
+declare const ARMOR_SLOT_IDS: readonly ["head", "body", "hands", "legs", "feet"];
+type ArmorSlotId = (typeof ARMOR_SLOT_IDS)[number];
+declare const WEAPON_SLOT_IDS: readonly ["main", "sub", "range"];
+type WeaponSlotId = (typeof WEAPON_SLOT_IDS)[number];
+declare const MAIN_WEAPON_TYPES: readonly ["hand_to_hand", "dagger", "sword", "great_sword", "axe", "great_axe", "scythe", "polearm", "katana", "great_katana", "club", "staff"];
+type MainWeaponType = (typeof MAIN_WEAPON_TYPES)[number];
+declare const SUB_WEAPON_TYPES: readonly ["shield", "hand_to_hand", "dagger", "sword", "axe", "katana", "club"];
+type SubWeaponType = (typeof SUB_WEAPON_TYPES)[number];
+declare const RANGED_TYPES: readonly ["none", "throwing", "archery", "marksmanship", "stringed", "wind", "handbell"];
+type RangedType = (typeof RANGED_TYPES)[number];
+/** Picker category excluding `ranged.none` (not an item lookup). */
+type WeaponPickerType = MainWeaponType | SubWeaponType | Exclude<RangedType, "none">;
+type PickerSlot = WeaponSlotId | ArmorSlotId;
+declare function isArmorSlot(slot: PickerSlot): slot is ArmorSlotId;
+declare function isWeaponSlot(slot: PickerSlot): slot is WeaponSlotId;
+declare function weaponTypesForSlot(slot: WeaponSlotId): readonly string[];
+
+/** Windower/API-aligned appearance (raceId 0–7, faceId 0–31, equipment item IDs). */
+interface CharacterAppearanceById {
+    raceId: number;
+    faceId: number;
+    itemIds?: Partial<Record<ModelSlotId, number>>;
+}
+/** Tooling shape — only `race` string differs from ById. */
+interface CharacterAppearanceByName {
+    race: RaceGenderName;
+    faceId: number;
+    itemIds?: Partial<Record<ModelSlotId, number>>;
+}
+type CharacterAppearance = CharacterAppearanceById | CharacterAppearanceByName;
+interface AppearanceResolution {
+    resolvedModels: Partial<Record<ModelSlotId, number>>;
+    missingItems: Partial<Record<ModelSlotId, number>>;
+    meshCount: number;
+}
+type CharacterViewerErrorCode = "webgl_unavailable" | "asset_fetch_failed" | "invalid_appearance";
+declare class CharacterViewerError extends Error {
+    readonly code: CharacterViewerErrorCode;
+    constructor(code: CharacterViewerErrorCode, message: string);
+}
+type ViewerStatus = "loading" | "ready" | "error";
+interface ViewerDebugInfo {
+    status: ViewerStatus;
+    meshCount: number;
+    raceId: number;
+    raceName: RaceGenderName | null;
+    faceId: number;
+    resolvedModels: Partial<Record<ModelSlotId, number>>;
+    missingItems: Partial<Record<ModelSlotId, number>>;
+    framingRadius: number;
+    orbit: {
+        x: number;
+        y: number;
+        radius: number;
+    };
+    error: string | null;
+}
+type ViewerState = {
+    status: "loading";
+} | {
+    status: "ready";
+    meshCount: number;
+    framingRadius: number;
+    appearance: {
+        raceId: number;
+        raceName: RaceGenderName;
+        faceId: number;
+    };
+    resolution: AppearanceResolution;
+    orbit: {
+        x: number;
+        y: number;
+        radius: number;
+    };
+    debugInfo?: ViewerDebugInfo;
+} | {
+    status: "error";
+    error: CharacterViewerError;
+};
+declare const DEFAULT_VIEWER_BACKGROUND = "#14171f";
+interface ViewerOverlayState {
+    status: ViewerStatus;
+    meshCount: number;
+    orbit: {
+        x: number;
+        y: number;
+        radius: number;
+        framingRadius: number;
+    };
+    isDragging: boolean;
+    canRotate: boolean;
+    canZoom: boolean;
+    resolution: AppearanceResolution | null;
+    resetView: () => void;
+    setOrbit: (patch: Partial<{
+        x: number;
+        y: number;
+        radius: number;
+    }>) => void;
+}
+
+interface StudioLighting {
+    ambient: [number, number, number, number];
+    diffuse0Dir: [number, number, number];
+    diffuse0Color: [number, number, number, number];
+}
+
+export { type AppearanceResolution as A, type CharacterAppearance as C, DEFAULT_VIEWER_BACKGROUND as D, type ModelSlotId as M, type PickerSlot as P, type RaceGenderName as R, type StudioLighting as S, type ViewerDebugInfo as V, type WeaponPickerType as W, type CharacterAppearanceById as a, type CharacterAppearanceByName as b, type CharacterItemLook as c, ARMOR_SLOT_IDS as d, type ArmorSlotId as e, CharacterViewerError as f, type CharacterViewerErrorCode as g, MAIN_WEAPON_TYPES as h, MODEL_SLOT_IDS as i, type MainWeaponType as j, RANGED_TYPES as k, type RangedType as l, SUB_WEAPON_TYPES as m, type SubWeaponType as n, type ViewerOverlayState as o, type ViewerState as p, type ViewerStatus as q, WEAPON_SLOT_IDS as r, type WeaponSlotId as s, isArmorSlot as t, isWeaponSlot as u, weaponTypesForSlot as w };

package/dist/react.d.ts

@@ -0,0 +1,118 @@
+import * as react from 'react';
+import { CSSProperties, ReactNode, Ref } from 'react';
+import { C as CharacterAppearance, S as StudioLighting, f as CharacterViewerError, o as ViewerOverlayState, p as ViewerState, A as AppearanceResolution } from './lighting-Bn1ftR_s.js';
+export { a as CharacterAppearanceById, b as CharacterAppearanceByName, M as ModelSlotId, V as ViewerDebugInfo } from './lighting-Bn1ftR_s.js';
+
+/** Two-axis orbit. X = horizontal model spin, Y = vertical camera tilt. */
+interface RotateOptions {
+    enabled?: boolean;
+    initialX?: number;
+    x?: number;
+    onXChange?: (x: number) => void;
+    initialY?: number;
+    y?: number;
+    onYChange?: (y: number) => void;
+    xLimit?: number;
+    yLimit?: [number, number];
+    sensitivity?: number | {
+        x?: number;
+        y?: number;
+    };
+    smoothing?: number;
+    autoRotate?: boolean;
+    autoRotateSpeed?: number;
+}
+interface CharacterViewerCanvasOptions {
+    /** Omitted = transparent alpha canvas. */
+    backgroundColor?: string;
+    className?: string;
+    lighting?: "default" | "day" | "night" | StudioLighting;
+    pixelRatio?: number;
+}
+interface CharacterViewerFallbacks {
+    loading?: ReactNode | false;
+    empty?: ReactNode;
+    error?: ReactNode | ((error: CharacterViewerError) => ReactNode);
+}
+/**
+ * Race, face, and equipped item IDs for the 3D character viewer.
+ * @see CharacterAppearanceById — primary Windower/API shape
+ */
+interface CharacterViewerProps {
+    appearance: CharacterAppearance;
+    width?: number | string;
+    height?: number | string;
+    minHeight?: number;
+    className?: string;
+    style?: CSSProperties;
+    canvas?: CharacterViewerCanvasOptions;
+    /** Drag orbit (X spin + Y tilt). Default: true */
+    rotate?: boolean | RotateOptions;
+    /** Scroll/pinch zoom. Default: false */
+    zoom?: boolean;
+    /** Play race idle animation. Default: true */
+    idleAnimation?: boolean;
+    /**
+     * Pause render loop.
+     * `true` — paused. Omitted/`false` — running (auto-pauses offscreen).
+     * `{ offscreen: false }` — keep rendering when scrolled away.
+     */
+    pause?: boolean | {
+        offscreen?: boolean;
+    };
+    showResetButton?: boolean;
+    cursor?: "default" | "grab" | "none";
+    pointerEvents?: "auto" | "none";
+    fallbacks?: CharacterViewerFallbacks;
+    overlay?: (state: ViewerOverlayState) => ReactNode;
+    debug?: boolean;
+    ariaLabel?: string;
+    role?: string;
+    tabIndex?: number;
+    onStateChange?: (state: ViewerState) => void;
+    ref?: Ref<CharacterViewerHandle>;
+}
+interface CharacterViewerHandle {
+    resetView(): void;
+    getState(): ViewerState;
+    getOrbit(): {
+        x: number;
+        y: number;
+        radius: number;
+    };
+    setOrbit(patch: Partial<{
+        x: number;
+        y: number;
+        radius: number;
+    }>): void;
+}
+
+declare function CharacterViewer({ appearance, width, height, minHeight, className, style, canvas, rotate, zoom, idleAnimation, pause, showResetButton, cursor, pointerEvents, fallbacks, overlay, debug, ariaLabel, role, tabIndex, onStateChange, ref, }: CharacterViewerProps): react.JSX.Element;
+
+type UseCharacterSceneOptions = Pick<CharacterViewerProps, "rotate" | "zoom" | "idleAnimation" | "pause" | "canvas" | "debug" | "onStateChange">;
+interface CharacterSceneState {
+    viewerState: ViewerState;
+    resolution: AppearanceResolution | null;
+    isDragging: boolean;
+    canvasHandlers: {
+        onPointerDown: (event: React.PointerEvent<HTMLCanvasElement>) => void;
+        onPointerMove: (event: React.PointerEvent<HTMLCanvasElement>) => void;
+        onPointerUp: (event: React.PointerEvent<HTMLCanvasElement>) => void;
+        onPointerLeave: (event: React.PointerEvent<HTMLCanvasElement>) => void;
+        onWheel: (event: React.WheelEvent<HTMLCanvasElement>) => void;
+    };
+    resetView: () => void;
+    getOrbit: () => {
+        x: number;
+        y: number;
+        radius: number;
+    };
+    setOrbit: (patch: Partial<{
+        x: number;
+        y: number;
+        radius: number;
+    }>) => void;
+}
+declare function useCharacterScene(canvasRef: React.RefObject<HTMLCanvasElement | null>, appearance: CharacterAppearance, options?: UseCharacterSceneOptions): CharacterSceneState;
+
+export { AppearanceResolution, CharacterAppearance, type CharacterSceneState, CharacterViewer, type CharacterViewerCanvasOptions, CharacterViewerError, type CharacterViewerFallbacks, type CharacterViewerHandle, type CharacterViewerProps, type RotateOptions, type UseCharacterSceneOptions, ViewerOverlayState, ViewerState, useCharacterScene };