@spatialwalk/avatarkit 1.0.0-beta.27 → 1.0.0-beta.28

package/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [1.0.0-beta.28] - 2025-12-08
+
+### 🔄 Breaking Changes
+- **Class Renamed** - `AvatarKit` class has been renamed to `AvatarSDK` for better consistency
+  - Update all imports: `import { AvatarKit } from '@spatialwalk/avatarkit'` → `import { AvatarSDK } from '@spatialwalk/avatarkit'`
+  - Update all API calls: `AvatarKit.initialize()` → `AvatarSDK.initialize()`
+  - All static methods and properties remain the same, only the class name has changed
+
+### 🔧 Improvements
+- **Rendering Optimizations** - Added fragment shader discard optimization to improve performance and edge quality
+- **Shader Alignment** - Removed view matrix transpose to align with Android SDK implementation
+- **Resource Cleanup** - Removed unused `frameMono` and `audioMono` resources from SDK and tests
+
 ## [1.0.0-beta.27] - 2025-12-04
 
 ### 🐛 Bugfix
@@ -115,8 +130,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Fallback mode is interruptible, just like normal playback mode
 
 ### 🔧 API Changes
-- **Playback Mode Configuration** - Moved playback mode configuration from `AvatarView` constructor to `AvatarKit.initialize()`
-  - Playback mode is now determined by `drivingServiceMode` in `AvatarKit.initialize()` configuration
+- **Playback Mode Configuration** - Moved playback mode configuration from `AvatarView` constructor to `AvatarSDK.initialize()`
+  - Playback mode is now determined by `drivingServiceMode` in `AvatarSDK.initialize()` configuration
   - `AvatarView` constructor now only requires `avatar` and `container` parameters
   - Removed `AvatarViewOptions` interface
   - `container` parameter is now required (no longer optional)
@@ -222,7 +237,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### 📚 Documentation
 - Updated demo repository link in README.md
-  - Changed example project link from `Avatarkit-web-demo` to `AvatarKit-Web-Demo` to match the new repository name
+  - Changed example project link from `Avatarkit-web-demo` to `AvatarSDK-Web-Demo` to match the new repository name
 
 ---
 
@@ -232,7 +247,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Cleaned up public API to hide internal implementation details
   - Marked internal methods with `@internal` JSDoc tag to exclude them from TypeScript declarations
   - Removed unused environment configuration options (`realtimeApiBaseUrl`, `realtimeWsUrl`)
-  - Added `appId` getter to `AvatarKit` for accessing initialized app ID
+  - Added `appId` getter to `AvatarSDK` for accessing initialized app ID
   - Internal methods like `getEnvironmentConfig`, `logEvent`, `getCanvas`, `getCameraConfig`, `updateCameraConfig` are now properly hidden from public API
 
 ### 🐛 Bug Fixes

package/README.md

@@ -1,4 +1,4 @@
-# SPAvatarKit SDK
+# SPAvatarSDK SDK
 
 Real-time virtual avatar rendering SDK based on 3D Gaussian Splatting, supporting audio-driven animation rendering and high-quality 3D rendering.
 
@@ -24,7 +24,7 @@ npm install @spatialwalk/avatarkit
 
 ```typescript
 import { 
-  AvatarKit, 
+  AvatarSDK, 
   AvatarManager, 
   AvatarView,
   Configuration,
@@ -47,10 +47,10 @@ const configuration: Configuration = {
   // - LogLevel.all: All logs (info, warning, error)
 }
 
-await AvatarKit.initialize('your-app-id', configuration)
+await AvatarSDK.initialize('your-app-id', configuration)
 
 // Set sessionToken (if needed, call separately)
-// AvatarKit.setSessionToken('your-session-token')
+// AvatarSDK.setSessionToken('your-session-token')
 
 // 2. Load character
 const avatarManager = AvatarManager.shared
@@ -59,7 +59,7 @@ const avatar = await avatarManager.load('character-id', (progress) => {
 })
 
 // 3. Create view (automatically creates Canvas and AvatarController)
-// The playback mode is determined by drivingServiceMode in AvatarKit configuration
+// The playback mode is determined by drivingServiceMode in AvatarSDK configuration
 // - DrivingServiceMode.sdk: SDK mode - SDK handles WebSocket communication
 // - DrivingServiceMode.host: Host mode - Host app provides audio and animation data
 const container = document.getElementById('avatar-container')
@@ -94,7 +94,7 @@ avatarView.avatarController.yieldFramesData(animationData, conversationId)
 
 Check the example code in the GitHub repository for complete usage flows for both modes.
 
-**Example Project:** [AvatarKit-Web-Demo](https://github.com/spatialwalk/AvatarKit-Web-Demo)
+**Example Project:** [AvatarSDK-Web-Demo](https://github.com/spatialwalk/AvatarSDK-Web-Demo)
 
 This repository contains complete examples for Vanilla JS, Vue 3, and React, demonstrating:
 - SDK mode: Real-time audio input with automatic animation data reception
@@ -112,30 +112,30 @@ The SDK uses a three-layer architecture for clear separation of concerns:
 
 ### Core Components
 
-- **AvatarKit** - SDK initialization and management
+- **AvatarSDK** - SDK initialization and management
 - **AvatarManager** - Character resource loading and management
 - **AvatarView** - 3D rendering view (rendering layer)
 - **AvatarController** - Audio/animation playback controller (playback layer)
 
 ### Playback Modes
 
-The SDK supports two playback modes, configured in `AvatarKit.initialize()`:
+The SDK supports two playback modes, configured in `AvatarSDK.initialize()`:
 
 #### 1. SDK Mode (Default)
-- Configured via `drivingServiceMode: DrivingServiceMode.sdk` in `AvatarKit.initialize()`
+- Configured via `drivingServiceMode: DrivingServiceMode.sdk` in `AvatarSDK.initialize()`
 - SDK handles WebSocket communication automatically
 - Send audio data via `AvatarController.send()`
 - SDK receives animation data from backend and synchronizes playback
 - Best for: Real-time audio input scenarios
 
 #### 2. Host Mode
-- Configured via `drivingServiceMode: DrivingServiceMode.host` in `AvatarKit.initialize()`
+- Configured via `drivingServiceMode: DrivingServiceMode.host` in `AvatarSDK.initialize()`
 - Host application manages its own network/data fetching
 - Host application provides both audio and animation data
 - SDK only handles synchronized playback
 - Best for: Custom data sources, pre-recorded content, or custom network implementations
 
-**Note:** The playback mode is determined by `drivingServiceMode` in `AvatarKit.initialize()` configuration.
+**Note:** The playback mode is determined by `drivingServiceMode` in `AvatarSDK.initialize()` configuration.
 
 ### Fallback Mechanism
 
@@ -209,40 +209,40 @@ RenderSystem → WebGPU/WebGL → Canvas rendering
 
 ## 📚 API Reference
 
-### AvatarKit
+### AvatarSDK
 
 The core management class of the SDK, responsible for initialization and global configuration.
 
 ```typescript
 // Initialize SDK
-await AvatarKit.initialize(appId: string, configuration: Configuration)
+await AvatarSDK.initialize(appId: string, configuration: Configuration)
 
 // Check initialization status
-const isInitialized = AvatarKit.isInitialized
+const isInitialized = AvatarSDK.isInitialized
 
 // Get initialized app ID
-const appId = AvatarKit.appId
+const appId = AvatarSDK.appId
 
 // Get configuration
-const config = AvatarKit.configuration
+const config = AvatarSDK.configuration
 
 // Set sessionToken (if needed, call separately)
-AvatarKit.setSessionToken('your-session-token')
+AvatarSDK.setSessionToken('your-session-token')
 
 // Set userId (optional, for telemetry)
-AvatarKit.setUserId('user-id')
+AvatarSDK.setUserId('user-id')
 
 // Get sessionToken
-const sessionToken = AvatarKit.sessionToken
+const sessionToken = AvatarSDK.sessionToken
 
 // Get userId
-const userId = AvatarKit.userId
+const userId = AvatarSDK.userId
 
 // Get SDK version
-const version = AvatarKit.version
+const version = AvatarSDK.version
 
 // Cleanup resources (must be called when no longer in use)
-AvatarKit.cleanup()
+AvatarSDK.cleanup()
 ```
 
 ### AvatarManager
@@ -280,7 +280,7 @@ constructor(avatar: Avatar, container: HTMLElement)
   - SDK automatically handles resize events via ResizeObserver
 
 **Playback Mode:**
-- The playback mode is determined by `drivingServiceMode` in `AvatarKit.initialize()` configuration
+- The playback mode is determined by `drivingServiceMode` in `AvatarSDK.initialize()` configuration
 - The playback mode is fixed when creating `AvatarView` and persists throughout its lifecycle
 - Cannot be changed after creation
 
@@ -432,7 +432,7 @@ enum LogLevel {
   - `LogLevel.error`: Only error logs
   - `LogLevel.warning`: Warning and error logs
   - `LogLevel.all` (default): All logs (info, warning, error)
-- `sessionToken`: Set separately via `AvatarKit.setSessionToken()`, not in Configuration
+- `sessionToken`: Set separately via `AvatarSDK.setSessionToken()`, not in Configuration
 
 ```typescript
 enum Environment {

package/dist/{StreamingAudioPlayer-C6v9Ed55.js → StreamingAudioPlayer-DLwlYvg8.js}

@@ -1,7 +1,7 @@
 var C = Object.defineProperty;
 var g = (h, t, e) => t in h ? C(h, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : h[t] = e;
 var s = (h, t, e) => g(h, typeof t != "symbol" ? t + "" : t, e);
-import { A as m, e as f, l as c, a as n } from "./index-s9KqPWVW.js";
+import { A as m, e as f, l as c, a as n } from "./index-ByaJBTpA.js";
 class y {
   constructor(t) {
     // AudioContext is managed internally

package/dist/core/AvatarDownloader.d.ts

@@ -65,12 +65,12 @@ export declare class AvatarDownloader {
      */
     clear(): void;
     /**
-     * Get SPAvatarKit SDK API Client (api.open.spatialwalk.top for cn, api.open.spatialwalk.cloud for intl)
+     * Get SPAvatarSDK SDK API Client (api.open.spatialwalk.top for cn, api.open.spatialwalk.cloud for intl)
      * Used for: character details and resource URLs (public endpoints, no auth required)
      */
     private getSdkApiClient;
     /**
-     * Get single character by ID from SPAvatarKit SDK API (v2, iOS compatible)
+     * Get single character by ID from SPAvatarSDK SDK API (v2, iOS compatible)
      * Domain: api.open.spatialwalk.top (cn) / api.open.spatialwalk.cloud (intl)
      * Auth: Public endpoint, no authentication required
      * Returns CharacterMeta with nested resource structure

package/dist/core/{AvatarKit.d.ts → AvatarSDK.d.ts}

@@ -1,5 +1,5 @@
 import { Configuration } from '../types';
-export declare class AvatarKit {
+export declare class AvatarSDK {
     private static _isInitialized;
     private static _configuration;
     private static readonly _version;