simple-pixi-spine 0.1.0

package/dist/types/packages/runtime-4.2/src/core/attachments/Sequence.d.ts

@@ -0,0 +1,35 @@
+import { IHasTextureRegion, ISequence, TextureRegion } from '@pixi-spine/base';
+import type { Slot } from '../Slot.js';
+/**
+ * @public
+ */
+export declare class Sequence implements ISequence {
+    private static _nextID;
+    id: number;
+    regions: TextureRegion[];
+    start: number;
+    digits: number;
+    /** The index of the region to show for the setup pose. */
+    setupIndex: number;
+    constructor(count: number);
+    copy(): Sequence;
+    apply(slot: Slot, attachment: IHasTextureRegion): void;
+    getPath(basePath: string, index: number): string;
+    private static nextID;
+}
+/**
+ * @public
+ * */
+export declare enum SequenceMode {
+    hold = 0,
+    once = 1,
+    loop = 2,
+    pingpong = 3,
+    onceReverse = 4,
+    loopReverse = 5,
+    pingpongReverse = 6
+}
+/**
+ * @public
+ * */
+export declare const SequenceModeValues: SequenceMode[];

package/dist/types/packages/runtime-4.2/src/core/attachments/index.d.ts

@@ -0,0 +1,9 @@
+export * from './Attachment.js';
+export * from './AttachmentLoader.js';
+export * from './BoundingBoxAttachment.js';
+export * from './ClippingAttachment.js';
+export * from './MeshAttachment.js';
+export * from './PathAttachment.js';
+export * from './PointAttachment.js';
+export * from './RegionAttachment.js';
+export * from './Sequence.js';

package/dist/types/packages/runtime-4.2/src/core/index.d.ts

@@ -0,0 +1,29 @@
+export * from './Animation.js';
+export * from './AnimationState.js';
+export * from './AnimationStateData.js';
+export * from './AtlasAttachmentLoader.js';
+export * from './Bone.js';
+export * from './BoneData.js';
+export * from './ConstraintData.js';
+export * from './Event.js';
+export * from './EventData.js';
+export * from './IkConstraint.js';
+export * from './IkConstraintData.js';
+export * from './PathConstraint.js';
+export * from './PathConstraintData.js';
+export * from './PhysicsConstraint.js';
+export * from './PhysicsConstraintData.js';
+export * from './polyfills.js';
+export * from './Skeleton.js';
+export * from './SkeletonBinary.js';
+export * from './SkeletonBounds.js';
+export * from './SkeletonClipping.js';
+export * from './SkeletonData.js';
+export * from './SkeletonJson.js';
+export * from './Skin.js';
+export * from './Slot.js';
+export * from './SlotData.js';
+export * from './TransformConstraint.js';
+export * from './TransformConstraintData.js';
+export * from './Triangulator.js';
+export * from './Updatable.js';

package/dist/types/packages/runtime-4.2/src/core/polyfills.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/packages/runtime-4.2/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from './core/';
+export * from './core/attachments';
+export * from './Spine';

package/dist/types/src/BinaryInput.d.ts

@@ -0,0 +1,84 @@
+/**
+ * Spine 二进制骨骼文件 (.skel) 数据流读取辅助类
+ */
+export declare class BinaryInput {
+    index: number;
+    buffer: DataView;
+    strings: string[];
+    /**
+     * @param buffer - 二进制文件 Buffer 数据
+     */
+    constructor(buffer: ArrayBuffer);
+    /**
+     * 读取 1 字节无符号整数
+     */
+    readByte(): number;
+    /**
+     * 读取 1 字节有符号整数
+     */
+    readSByte(): number;
+    /**
+     * 读取 2 字节有符号短整数 (Big-Endian)
+     */
+    readShort(): number;
+    /**
+     * 读取 4 字节有符号整数 (Big-Endian)
+     */
+    readInt32(): number;
+    /**
+     * 读取可变长度整数 (Varint)
+     * @param optimizePositive - 是否优化正数
+     */
+    readVarint(optimizePositive: boolean): number;
+    /**
+     * 读取 RGBA 颜色对象
+     */
+    readColor(): {
+        r: number;
+        g: number;
+        b: number;
+        a: number;
+    };
+    /**
+     * 读取十六进制颜色字符串 (例如 "ffffffff")
+     */
+    readColorHex(): string;
+    /**
+     * 读取引用的字符串
+     */
+    readStringRef(): string | null;
+    /**
+     * 读取 UTF-8 编码的字符串
+     */
+    readString(): string | null;
+    /**
+     * 读取 4 字节单精度浮点数 (Big-Endian)
+     */
+    readFloat(): number;
+    /**
+     * 读取 Spine 2.1 版本特定的 4 字节单精度浮点数
+     */
+    readFloat21(): number;
+    /**
+     * 读取布尔值
+     */
+    readBoolean(): boolean;
+    /**
+     * 读取可变长度整数数组
+     */
+    readIntArray(): number[];
+    /**
+     * 读取关键帧贝塞尔曲线参数
+     * @returns - 'stepped' 或 [cx1, cy1, cx2, cy2]
+     */
+    readCurve(): 'stepped' | number[] | undefined;
+    /**
+     * 读取单精度浮点数数组
+     * @param n - 数组长度，如未提供则自数据流中读取长度
+     */
+    readFloatArray(n?: number): number[];
+    /**
+     * 读取短整数数组 (2字节 Big-Endian)
+     */
+    readShortArray(): number[];
+}

package/dist/types/src/SkelToJson.d.ts

@@ -0,0 +1,15 @@
+import { readSkeletonData21 } from './SkelToJson21';
+import { readSkeletonData34And35 } from './SkelToJson34And35';
+import { readSkeletonData36And37 } from './SkelToJson36And37';
+import { SpineSkeletonData } from './types';
+export { readSkeletonData21, readSkeletonData34And35, readSkeletonData36And37 };
+/**
+ * 将骨架数据从遗留版本格式规范化升级为 v3.8 标准 JSON 结构
+ * @param obj - 原始遗留版本 JSON 结构对象
+ * @returns 转换后的 3.8 标准对象
+ */
+export declare function normalizeTo38(obj: SpineSkeletonData): SpineSkeletonData;
+/**
+ * @deprecated 请使用 normalizeTo38 代替
+ */
+export declare function spine36To38(obj: SpineSkeletonData): SpineSkeletonData;

package/dist/types/src/SkelToJson21.d.ts

@@ -0,0 +1,10 @@
+import { SpineSkeletonData } from './types';
+/**
+ * Spine v2.0/v2.1 二进制数据解析模块
+ */
+/**
+ * 从二进制数据解析为 v2.0/v2.1 JSON 结构对象
+ * @param binary - 二进制字节数据
+ * @returns JSON 结构对象
+ */
+export declare function readSkeletonData21(binary: ArrayBuffer): SpineSkeletonData;

package/dist/types/src/SkelToJson34And35.d.ts

@@ -0,0 +1,10 @@
+import { SpineSkeletonData } from './types';
+/**
+ * Spine v3.4/v3.5 二进制数据解析模块
+ */
+/**
+ * 从二进制数据解析为 v3.4/v3.5 JSON 结构对象
+ * @param binary - 二进制字节数据
+ * @returns JSON 结构对象
+ */
+export declare function readSkeletonData34And35(binary: ArrayBuffer): SpineSkeletonData;

package/dist/types/src/SkelToJson36And37.d.ts

@@ -0,0 +1,10 @@
+import { SpineSkeletonData } from './types';
+/**
+ * Spine v3.6/v3.7 二进制数据解析模块
+ */
+/**
+ * 从二进制数据解析为 v3.6/v3.7 JSON 结构对象
+ * @param binary - 二进制字节数据
+ * @returns JSON 结构对象
+ */
+export declare function readSkeletonData36And37(binary: ArrayBuffer): SpineSkeletonData;

package/dist/types/src/SkelToJsonCommon.d.ts

@@ -0,0 +1,24 @@
+import { BinaryInput } from './BinaryInput';
+import { SpineSkeletonData, AttachmentData, SkinData } from './types';
+/**
+ * Spine 各个版本解析器共用的公共底层读取与解析函数
+ */
+/**
+ * 读取顶点权重与坐标数据
+ */
+export declare function readVertices(input: BinaryInput, attachment: AttachmentData, vertexCount: number): void;
+/**
+ * 解析单个 Attachment 数据 (v3.4 - v3.7)
+ */
+export declare function readAttachment(input: BinaryInput, attachmentName: string, skeletonData: SpineSkeletonData, nonessential: boolean): AttachmentData;
+/**
+ * 解析单个 Skin 数据 (v3.4 - v3.7)
+ */
+export declare function readSkin(input: BinaryInput, skeletonData: SpineSkeletonData, nonessential: boolean): SkinData | null;
+/**
+ * 解析动画数据 (v3.4 - v3.7)
+ */
+export declare function readAnimation(input: BinaryInput, skeletonData: SpineSkeletonData, skins: {
+    name: string;
+    data: SkinData | null;
+}[], version?: number): any;

package/dist/types/src/TextureHelper.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 纹理与图像数据处理辅助模块
+ */
+export declare const INV_ALPHA_TABLE: Float32Array;
+/**
+ * 判断 RGBA 数组是否为预乘 Alpha 格式
+ * @param imageData - RGBA 像素数据字节数组
+ * @param tolerance - 容差范围值
+ */
+export declare function isPremultipliedAlpha(imageData: Uint8Array | Uint8ClampedArray, tolerance?: number): boolean;
+/**
+ * 探测 PIXI BaseTexture 是否为预乘纹理
+ * @param baseTexture - PIXI.BaseTexture 实例或相关包装对象
+ */
+export declare function isPremultiplied(baseTexture: any): boolean;
+/**
+ * 图像重采样：将 RGBA 缓冲数据调整为目标尺寸（双线性插值或临近插值采样）
+ * @param buffer - 原始 RGBA 数据缓冲
+ * @param oldW - 原始宽度
+ * @param oldH - 原始高度
+ * @param newW - 目标宽度
+ * @param newH - 目标高度
+ */
+export declare function resizeRgbaBuffer(buffer: Uint8Array, oldW: number, oldH: number, newW: number, newH: number): Uint8Array;
+/**
+ * 将预乘 Alpha (Premultiplied Alpha) 还原为直色 Alpha (Straight Alpha)
+ * @param rgbaArray - 原始 RGBA 缓冲数组
+ */
+export declare function premultipliedToStraight(rgbaArray: Uint8Array | Uint8ClampedArray): Uint8Array;

package/dist/types/src/VersionDetector.d.ts

@@ -0,0 +1,28 @@
+import { VersionConfig } from './types';
+/**
+ * Spine 资源版本映射配置与检测模块
+ */
+/**
+ * Spine 版本映射配置
+ * 用于定义原始版本、目标解析版本以及转换处理器
+ */
+export declare const versionMap: Record<number, VersionConfig>;
+/**
+ * 将 Uint8Array 转换为字符串
+ * @param u8Arr - 二进制字节数组
+ * @param encoding - 编码格式，默认为 'ascii'
+ */
+export declare function uint8ArrayToString(u8Arr: Uint8Array, encoding?: string): string;
+/**
+ * 判断字符串或对象是否符合 Spine 版本特征，并返回标准化版本号 (如 "38")
+ * @param str - 待检测的字符串或 JSON 对象
+ */
+export declare function isVersion(str: any): string | null;
+/**
+ * 从二进制或 JSON 数据中自动识别 Spine 编辑器版本
+ */
+export declare function detectSpineVersion({ data, type, fallbackVersion, }: {
+    data: ArrayBuffer | string;
+    type: 'skel' | 'json';
+    fallbackVersion?: string;
+}): string | null;

package/dist/types/src/index.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 显式注册 PIXI 实例，以便在非浏览器/无全局 window 的环境下运行（如 SSR 或单元测试）
+ * @param pixi - PIXI 实例
+ */
+export declare function registerPIXI(pixi: any): void;
+/**
+ * 获取当前的 PIXI 实例
+ */
+export declare function getPIXI(): any;
+import { normalizeTo38, spine36To38, readSkeletonData36And37, readSkeletonData34And35, readSkeletonData21 } from './SkelToJson';
+import { detectSpineVersion, isVersion, versionMap } from './VersionDetector';
+import { TextureInfo, TextureData, MemorySpineSource } from './types';
+export { normalizeTo38, spine36To38, readSkeletonData36And37, readSkeletonData34And35, readSkeletonData21 };
+export { detectSpineVersion, isVersion, versionMap };
+/**
+ * 获取文件目录路径
+ * @param src - 文件路径
+ * @returns 目录路径，以 '/' 结尾
+ */
+export declare function getFileDirectory(src: string): string;
+/**
+ * 解析 Atlas 文本以获取纹理信息列表
+ * @param atlasData - Atlas 文本内容
+ */
+export declare function getTextureAtlasInfo(atlasData: string): TextureInfo[];
+/**
+ * 提取骨骼、图集和纹理的完整访问路径
+ * @param src - 资源来源路径或配置对象
+ * @param options - 配置项
+ */
+export declare function getSpineSrc(src: any, options?: any): any;
+/**
+ * 构造纹理加载信息列表
+ * @param atlasData - Atlas 文本
+ * @param textureBasePath - 纹理基础目录路径
+ */
+export declare function prepareTextureData(atlasData: string, textureBasePath: string): TextureData[];
+/**
+ * 基于原生 XMLHttpRequest (AJAX) 请求文件
+ * @param url - 目标 URL
+ * @param responseType - 响应数据类型 (text, arraybuffer)
+ * @param options - 配置参数，如 onProgress
+ */
+export declare function loadFile(url: string, responseType?: string, options?: any): Promise<{
+    data: any;
+    status: number;
+}>;
+/**
+ * 核心解析方法：绑定纹理并调用对应版本的 Spine SDK 进行解析
+ * @param config
+ */
+export declare function readSpineSpineData(config: any): Promise<any>;
+/**
+ * 数据预处理：执行版本检测、格式转换（skel -> json）以及跨版本兼容处理
+ * @param params
+ */
+export declare function processSpineData(params: any): Promise<any>;
+/**
+ * 外部加载入口函数，支持加载网络 URL 路径或直接加载内存中的预拉取数据对象
+ * @param src - 路径字符串、结构化的路径对象，或者 MemorySpineSource 内存资源对象
+ * @param options - 配置项
+ */
+export declare function load(src: string | object | MemorySpineSource, options?: any): Promise<any>;
+/**
+ * 实例化 Spine 对象并附加调试渲染器
+ * @param spineData - 由 load 方法返回的已处理数据对象
+ */
+export declare function spine(spineData: any): any;
+declare let SimplePixiSpine: {
+    load: typeof load;
+    spine: typeof spine;
+    loadFile: typeof loadFile;
+    detectSpineVersion: typeof detectSpineVersion;
+    isVersion: typeof isVersion;
+    versionMap: Record<number, import("./types").VersionConfig>;
+    registerPIXI: typeof registerPIXI;
+    getPIXI: typeof getPIXI;
+    normalizeTo38: typeof normalizeTo38;
+};
+export default SimplePixiSpine;

package/dist/types/src/types.d.ts

@@ -0,0 +1,161 @@
+export interface VersionConfig {
+    target: string;
+    handler: 'readSkeletonData21' | 'readSkeletonData34And35' | 'readSkeletonData36And37' | null;
+}
+export interface SkeletonInfo {
+    hash: string;
+    spine: string;
+    width: number;
+    height: number;
+    fps?: number;
+    images?: string;
+    audio?: string;
+}
+export interface BoneData {
+    name: string;
+    parent: string | null;
+    rotation?: number;
+    x?: number;
+    y?: number;
+    scaleX?: number;
+    scaleY?: number;
+    shearX?: number;
+    shearY?: number;
+    length?: number;
+    transform?: string;
+    inheritRotation?: boolean;
+    inheritScale?: boolean;
+    color?: string;
+}
+export interface SlotData {
+    name: string;
+    bone: string;
+    color?: string;
+    dark?: string;
+    attachment?: string;
+    blend?: 'normal' | 'additive' | 'multiply' | 'screen';
+}
+export interface IkConstraintData {
+    name: string;
+    order?: number;
+    bones: string[];
+    target: string;
+    mix: number;
+    bendPositive: boolean;
+    compress?: boolean;
+    stretch?: boolean;
+    uniform?: boolean;
+}
+export interface TransformConstraintData {
+    name: string;
+    order?: number;
+    bones: string[];
+    target: string;
+    local?: boolean;
+    relative?: boolean;
+    rotation: number;
+    x: number;
+    y: number;
+    scaleX: number;
+    scaleY: number;
+    shearY: number;
+    rotateMix: number;
+    translateMix: number;
+    scaleMix: number;
+    shearMix: number;
+}
+export interface PathConstraintData {
+    name: string;
+    order?: number;
+    bones: string[];
+    target: string;
+    positionMode: 'fixed' | 'percent';
+    spacingMode: 'length' | 'fixed' | 'percent';
+    rotateMode: 'tangent' | 'chain' | 'chainScale';
+    rotation: number;
+    position: number;
+    spacing: number;
+    rotateMix: number;
+    translateMix: number;
+}
+export interface AttachmentData {
+    name?: string;
+    type?: 'region' | 'boundingbox' | 'mesh' | 'linkedmesh' | 'path' | 'point' | 'clipping';
+    path?: string;
+    rotation?: number;
+    x?: number;
+    y?: number;
+    scaleX?: number;
+    scaleY?: number;
+    width?: number;
+    height?: number;
+    color?: string;
+    vertexCount?: number;
+    vertices?: number[];
+    verticesCount?: number;
+    bonesCount?: number;
+    uvs?: number[];
+    triangles?: number[];
+    hull?: number;
+    edges?: number[];
+    skin?: string;
+    parent?: string;
+    inheritDeform?: boolean;
+    closed?: boolean;
+    constantSpeed?: boolean;
+    lengths?: number[];
+    end?: string;
+}
+export interface SkinData {
+    [slotName: string]: {
+        [attachmentName: string]: AttachmentData;
+    };
+}
+export interface EventData {
+    intValue?: number;
+    floatValue?: number;
+    stringValue?: string;
+    audioPath?: string;
+    volume?: number;
+    balance?: number;
+}
+export interface SpineSkeletonData {
+    skeleton?: SkeletonInfo;
+    bones?: BoneData[];
+    slots?: SlotData[];
+    ik?: IkConstraintData[];
+    transform?: TransformConstraintData[];
+    path?: PathConstraintData[];
+    skins?: {
+        [skinName: string]: SkinData;
+    } | SkinData[];
+    events?: {
+        [eventName: string]: EventData;
+    };
+    animations?: {
+        [animationName: string]: any;
+    };
+    defaultSkin?: SkinData;
+}
+export interface TextureInfo {
+    name: string;
+    width: number;
+    height: number;
+}
+export interface TextureData {
+    name: string;
+    src?: string;
+    data?: Uint8Array | ArrayBuffer;
+    width?: number;
+    height?: number;
+    texture?: any;
+}
+export interface MemorySpineSource {
+    skeletonData: ArrayBuffer | string | object;
+    atlasData: string;
+    textureData?: TextureData[];
+    texturePath?: string;
+    version?: string;
+    path?: string[];
+    atlasPath?: string;
+}

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "simple-pixi-spine",
+  "version": "0.1.0",
+  "description": "Unified spine-pixi runtime with SimplePixiSpine wrapper built using Esbuild",
+  "main": "./dist/simple-pixi-spine.js",
+  "module": "./dist/simple-pixi-spine.mjs",
+  "types": "./dist/types/src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/src/index.d.ts",
+      "import": "./dist/simple-pixi-spine.mjs",
+      "require": "./dist/simple-pixi-spine.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "node build.mjs && tsc"
+  },
+  "peerDependencies": {
+    "pixi.js": "^8.2.3"
+  },
+  "devDependencies": {
+    "@esotericsoftware/spine-pixi-v8": "^4.2.53",
+    "esbuild": "^0.19.11",
+    "typescript": "5.4.2"
+  }
+}