@series-inc/venus-sdk 2.6.2 → 3.0.0

package/README.md

@@ -31,8 +31,8 @@ await VenusAPI.initializeAsync()
 ### Profile API
 
 ```typescript
-// Get current user profile
-const profile = await VenusAPI.profile.getCurrentProfile()
+// Get current user profile (synchronous)
+const profile = VenusAPI.profile.getCurrentProfile()
 console.log(profile.name, profile.username)
 ```
 ---
@@ -90,27 +90,45 @@ if (rewardEarned) {
 
 ```typescript
 // Trigger haptic feedback
-await VenusAPI.haptics.trigger('success')
-await VenusAPI.haptics.trigger('warning')
-await VenusApi.haptics.trigger('light')
-await VenusApi.haptics.trigger('medium')
-await VenusAPI.haptics.trigger('heavy')
-
+await VenusAPI.haptics.triggerHapticAsync('success')
+await VenusAPI.haptics.triggerHapticAsync('warning')
+await VenusAPI.haptics.triggerHapticAsync('error')
+await VenusAPI.haptics.triggerHapticAsync('light')
+await VenusAPI.haptics.triggerHapticAsync('medium')
+await VenusAPI.haptics.triggerHapticAsync('heavy')
 ```
 ---
 
 ### Local Notifications API
 
 ```typescript
-  // Schedule a delayed notification
-  const id = await VenusApi.notifications.scheduleAsync({
-    title: 'Notification Title',
-    body: 'Notification Body',
-    trigger: {
-      type: 'timeInterval',
-      seconds: 60 // Delay in seconds (required)
-    },
-  })
+  // Schedule a delayed notification (minimal - required params only)
+  const id = await VenusApi.notifications.scheduleAsync(
+    'Notification Title',
+    'Notification Body',
+    60 // Delay in seconds
+  )
+  
+  // Schedule with optional notification ID
+  const id = await VenusApi.notifications.scheduleAsync(
+    'Notification Title',
+    'Notification Body',
+    60,
+    'custom-notification-id'
+  )
+  
+  // Schedule with all optional settings
+  const id = await VenusApi.notifications.scheduleAsync(
+    'Notification Title',
+    'Notification Body',
+    60,
+    'custom-notification-id',
+    {
+      priority: 100,          // 0-100, default 50
+      groupId: 'reminders',   // Group related notifications
+      payload: { key: 'value' } // Custom data
+    }
+  )
   
   // Cancel a notification
   await VenusApi.notifications.cancelNotification(notificationId)
@@ -156,13 +174,7 @@ The preloader is opt-in by default. In order to opt in, you must add
   // get VBucks/Hard Currency balance
   await VenusApi.iap.getHardCurrencyBalance()
   // Spend VBucks/Hard Currency
-  await VenusApi.iap.spendCurrency({
-    productId: 'yourProductID',
-    amount: '3',
-    options?: {
-      screenname: 'yourScreenName'
-    },
-  })
+  await VenusApi.iap.spendCurrency('yourProductID', 3)
   // Open Venus Store
   await VenusApi.iap.openStore()
   // Get Currency Icon
@@ -263,24 +275,26 @@ await VenusAPI.simulation.triggerRecipeChainAsync('battle_complete')
 
 ```typescript
 // Check requirements for a single recipe
-const requirements = await VenusAPI.simulation.getRecipeRequirementsAsync({
-  recipeId: 'craft_sword',
-  entity: 'player',
-  amount: 1
-})
-// Returns: { canAfford, costs, rewards }
+const requirements = await VenusAPI.simulation.getRecipeRequirementsAsync(
+  'craft_sword',
+  'player',
+  1
+)
+// Returns: { recipeId, entity, amount?, inputs, canAfford, disabled }
 
 // Batch check multiple recipes
 const results = await VenusAPI.simulation.getBatchRecipeRequirementsAsync([
-  { recipeId: 'craft_sword', amount: 1 },
-  { recipeId: 'craft_shield', amount: 2 }
+  { recipeId: 'craft_sword', batchAmount: 1 },
+  { recipeId: 'craft_shield', batchAmount: 2 }
 ])
+// Returns: { success, results, errors? }
 
 // Get available recipes
 const recipes = await VenusAPI.simulation.getAvailableRecipesAsync({
   roomId: 'room_123',
   includeActorRecipes: true
 })
+// Returns: { success, recipes }
 ```
 
 #### Slot Management
@@ -363,20 +377,20 @@ Three-tier storage system with different data scopes:
 
 ```typescript
 // Device Cache - persists across all apps for the device
-await VenusAPI.deviceCache.set('lastUserId', '12345')
-const userId = await VenusAPI.deviceCache.get('lastUserId')
+await VenusAPI.deviceCache.setItem('lastUserId', '12345')
+const userId = await VenusAPI.deviceCache.getItem('lastUserId')
 
 // App Storage - app-specific persistent storage
-await VenusAPI.appStorage.set('highScore', 1000)
-await VenusAPI.appStorage.set('playerData', { level: 5, gold: 1000 })
+await VenusAPI.appStorage.setItem('highScore', JSON.stringify(1000))
+await VenusAPI.appStorage.setItem('playerData', JSON.stringify({ level: 5, gold: 1000 }))
 
 // Global Storage - shared across all apps for the user
-await VenusAPI.globalStorage.set('preferences', { theme: 'dark' })
+await VenusAPI.globalStorage.setItem('preferences', JSON.stringify({ theme: 'dark' }))
 
 // All storage APIs support:
-const value = await storage.get(key, defaultValue?)
-await storage.set(key, value)
-await storage.remove(key)
+const value = await storage.getItem(key)
+await storage.setItem(key, value)
+await storage.removeItem(key)
 await storage.clear()
 const count = await storage.length()
 const keyName = await storage.key(index)
@@ -398,34 +412,35 @@ await VenusAPI.popups.showToast('Game saved!', {
 })
 
 // Alert dialog
-await VenusAPI.popups.showAlert({
-  title: 'Warning',
-  message: 'This action cannot be undone',
-  buttonText: 'OK'
-})
+await VenusAPI.popups.showAlert(
+  'Warning',
+  'This action cannot be undone',
+  { buttonText: 'OK' }
+)
 
 // Confirm dialog
-const confirmed = await VenusAPI.popups.showConfirm({
-  title: 'Delete Item',
-  message: 'Are you sure you want to delete this item?',
-  confirmText: 'Delete',
-  cancelText: 'Cancel'
-})
+const confirmed = await VenusAPI.popups.showConfirm(
+  'Delete Item',
+  'Are you sure you want to delete this item?',
+  { confirmText: 'Delete', cancelText: 'Cancel' }
+)
 
 if (confirmed) {
   // User confirmed
 }
 
 // Action sheet
-const selected = await VenusAPI.popups.showActionSheet({
-  title: 'Choose Action',
-  options: [
-    { id: 'edit', label: 'Edit', variant: 'default' },
-    { id: 'share', label: 'Share', variant: 'default' },
-    { id: 'delete', label: 'Delete', variant: 'destructive' }
+const selected = await VenusAPI.popups.showActionSheet(
+  [
+    { id: 'edit', label: 'Edit' },
+    { id: 'share', label: 'Share' },
+    { id: 'delete', label: 'Delete' }
   ],
-  cancelText: 'Cancel'
-})
+  {
+    title: 'Choose Action',
+    cancelButtonText: 'Cancel'
+  }
+)
 
 if (selected === 'delete') {
   // User selected delete
@@ -439,18 +454,17 @@ if (selected === 'delete') {
 Stack-based navigation system:
 
 ```typescript
-// Get current stack information
-const stack = await VenusAPI.navigation.getStackInfo()
-// Returns: { depth, currentApp, history }
+// Get current stack information (synchronous)
+const stack = VenusAPI.navigation.getStackInfo()
+// Returns: { isInStack, stackPosition, isTopOfStack, stackDepth, parentInstanceId }
 
 // Push new app to stack
-await VenusAPI.navigation.push({
-  appId: 'bird-flap',
-  context: { level: 5, difficulty: 'hard' }
+await VenusAPI.navigation.pushApp('bird-flap', {
+  contextData: { level: 5, difficulty: 'hard' }
 })
 
 // Pop from stack (returns to previous app)
-await VenusAPI.navigation.pop()
+await VenusAPI.navigation.popApp()
 ```
 
 ---
@@ -461,23 +475,27 @@ Social interaction APIs for posts:
 
 ```typescript
 // Get post interaction data
-const interactions = await VenusAPI.post.getInteractions()
-// Returns: { postId, isLiked, isFollowing, likeCount, commentCount }
+const postInfo = await VenusAPI.post.getPostInfo()
+// Returns: { isLiked, isFollowing, likesCount, commentsCount }
 
 // Toggle like
-await VenusAPI.post.toggleLike()
+const likeResult = await VenusAPI.post.toggleLikeAsync()
+// Returns: { isLiked, likesCount, action: 'liked' | 'unliked' }
 
 // Toggle follow
-await VenusAPI.post.toggleFollow()
+const followResult = await VenusAPI.post.toggleFollowAsync()
+// Returns: { isFollowing, action: 'followed' | 'unfollowed' }
 
 // Open comments UI
-await VenusAPI.post.openComments()
+const commentsResult = await VenusAPI.post.openCommentsAsync()
+// Returns: { opened, commentsCount }
 
 // Share post
-await VenusAPI.post.share({
+const shareResult = await VenusAPI.post.sharePostAsync({
   message: 'Check this out!',
-  recipientIds: ['user1', 'user2']
+  title: 'My Post'
 })
+// Returns: { shared, platform, customMessage? }
 ```
 
 ---
@@ -501,27 +519,32 @@ await VenusAPI.analytics.setUserProperty('vip_status', 'gold')
 ### Avatar 3D API
 
 ```typescript
-// Get current avatar configuration
-const avatar = await VenusAPI.avatar3d.get()
+// Load current avatar configuration
+const avatar = await VenusAPI.avatar3d.loadAvatar()
+// Or load a specific avatar
+const avatarConfig = await VenusAPI.avatar3d.loadAvatar('avatar_123')
 
 // Show avatar editor
 const result = await VenusAPI.avatar3d.showEditor({
-  allowSave: true,
-  enableSharing: true
+  currentAvatar: avatarConfig,
+  contextData: { source: 'settings' }
 })
 
-if (result.saved) {
-  console.log('Avatar updated:', result.avatarId)
+if (result.wasChanged && result.savedAvatarId) {
+  console.log('Avatar updated:', result.savedAvatarId)
 }
 
-// Delete avatar
-await VenusAPI.avatar3d.delete()
+// Save avatar
+const avatarId = await VenusAPI.avatar3d.saveAvatar(avatarConfig)
 
-// Get shared avatar
-const sharedAvatar = await VenusAPI.avatar3d.getSharedAvatar('avatar_123')
+// Delete avatar
+await VenusAPI.avatar3d.deleteAvatar()
 
 // Download avatar manifest
-const manifest = await VenusAPI.avatar3d.downloadManifest('avatar_123')
+const manifest = await VenusAPI.avatar3d.downloadManifest()
+
+// Download asset paths
+const assetPaths = await VenusAPI.avatar3d.downloadAssetPaths()
 ```
 
 ---
@@ -556,21 +579,28 @@ Server time synchronization and formatting:
 
 ```typescript
 // Get server time
-const serverTime = await VenusAPI.time.getServerTime()
-// Returns: { timestamp, timezone, formatted }
+const serverTimeData = await VenusAPI.time.requestTimeAsync()
+// Returns: { serverTime, localTime, timezoneOffset, formattedTime, locale }
 
 // Format time with locale
-const formatted = VenusAPI.time.format(Date.now(), {
+const formatted = VenusAPI.time.formatTime(Date.now(), {
   locale: 'en-US',
   format: 'full' // 'full', 'long', 'medium', 'short'
 })
 
 // Format number with locale
-const formatted = VenusAPI.time.formatNumber(1234567.89, {
+const formattedNumber = VenusAPI.time.formatNumber(1234567.89, {
   locale: 'en-US',
   style: 'currency',
   currency: 'USD'
 })
+
+// Get future time
+const futureTime = await VenusAPI.time.getFutureTimeAsync({
+  days: 1,
+  hours: 2,
+  minutes: 30
+})
 ```
 
 ---
@@ -578,11 +608,17 @@ const formatted = VenusAPI.time.formatNumber(1234567.89, {
 ### CDN API
 
 ```typescript
-// Get CDN URL for an asset
-const url = await VenusAPI.cdn.getAssetUrl('images/logo.png')
+// Resolve asset URLs (synchronous)
+const assetUrl = VenusAPI.cdn.resolveAssetUrl('images/logo.png')
+const avatarUrl = VenusAPI.cdn.resolveAvatarAssetUrl('avatars/model.glb')
+const libUrl = VenusAPI.cdn.resolveSharedLibUrl('libs/helper.js')
+
+// Get CDN base URL
+const baseUrl = VenusAPI.cdn.getAssetCdnBaseUrl()
 
-// Upload to CDN
-const uploadUrl = await VenusAPI.cdn.upload(file)
+// Fetch from CDN
+const response = await VenusAPI.cdn.fetchFromCdn('https://cdn.example.com/file.json')
+const blob = await VenusAPI.cdn.fetchBlob('path/to/asset.png')
 ```
 
 ---
@@ -592,15 +628,15 @@ const uploadUrl = await VenusAPI.cdn.upload(file)
 Feature flags, experiments, and A/B testing:
 
 ```typescript
-// Get feature flag value
+// Get feature flag value (returns boolean)
 const enabled = await VenusAPI.features.getFeatureFlag('new_ui_enabled')
 
-// Get feature gate (boolean flag)
+// Get feature gate (returns boolean)
 const canAccess = await VenusAPI.features.getFeatureGate('beta_features')
 
 // Get experiment variant
 const experiment = await VenusAPI.features.getExperiment('checkout_flow')
-// Returns: { variant: 'control' | 'variant_a' | 'variant_b', ... }
+// Returns: { name, ruleID, value, groupName } | null
 ```
 
 ### Lifecycle API