Changelog

[2.9.12]

Fixed

• Ads
  • Adding spinner for preroll ad on their cover

[2.9.11]

Fixed

• Ads
  • Adding spinner on inhouse ad
• Core
  • Resolve wortal init when timeout get user profile

[2.9.10]

Added

• Ads
  • Added support for rewarded ad on Tsutaya
• Core
  • Added support for Xiaomi as game channel

Changed

• Player
  • Get player info from wortal.games channel
• IAP
  • Removed dependencies from xsolla for wortal.games channel

[2.9.9]

Added

• Ads
  • Show non personalized ads before getting consent for Wortal

[2.9.8]

Fixed

• IAP
  • Make sure payment pop not blocked by browser

[2.9.7]

Fixed

• Session
  • Some channels don't support localstorage on Firefox, so we save session data to sessionStorage.

[2.9.6]

Added

• Session
  • Handle only can play game in a session on Tsutaya
• Core
  • Added Tsutaya helper SDK
  • Handle iframe resizer for Tsutaya

[2.9.5]

Fixed

• Auth
  • Always run GMO auth flow for each session to make sure session is overwritten

[2.9.4]

Fixed

• Core
  • Get data from cloud as early as possbile at platform init for kantangame
• Player
  • Handle empty data better for kantangame

[2.9.3]

Changed

• Player
  • Save and get data from local for kantangame
• Session
  • Get data from cloud when gameplayStart for kantangame
  • Save data to cloud when gameplayStop for kantangame

[2.9.2]

Fixed

• Adjust height on Mixi for Mobile

[2.9.1]

Fixed

• Failed to determine Tsutaya channel

[2.9.0]

Added

• Support Tsutaya channel

[2.8.1]

Added

• Support Mixi mobile (touch)

[2.8.0]

Added

• Support Mixi channel

[2.7.2]

Fixed

• Ad
  • Exuecute no fill for unsupported interstitial ad so game is not stuck
• Player
  • Handle data better when getData return empty string on KantanGame

[2.7.1]

Added

• Ad
  • Add mute/pause control

Fixed

• Ad
  • Using switchGameAsync for FB non iOS to open game from Ad
  • play inline video for iOS

[2.7.0]

Added

• Support in house ad to fill unsold inventory (except Poki and Addictinggames)

[2.6.0]

Added

• Added new channel support: Kantan Game Box
• Wortal Native
  • fix Ads Callback issue

[2.5.5]

Fixed

• IAP
  • Set productID as purchaseToken to fix consume item that needs purchaseToken

[2.5.4]

Added

• Wortal Native Platform
  • Ads

[2.5.3]

Changed

• Ad
  • Remove preroll ad from Poki
• Core
  • Add more domain to identify poki
  • Move poki game start event to session game start
  • Call poki gameLoadingFinished on progress 100 instead of game start

[2.5.2]

Fixed

• Show gesokoin as currency and it's value for GMO

[2.5.1]

Added

• GMO Ad Support

[2.5.0]

Added

• GMO Support

[2.4.0]

Added

• Telegram Wortal Support

[2.3.0]

Added

• Ad
  • Custom ad freq cap for wortal ad stack

[2.2.13]

Fixed

• IAP
  • Fix send duplicated purchase events from xsolla IAP
  • Fix sandbox check for xsolla IAP

[2.2.12]

Fixed

• IAP
  • Fix missing xsolla project id

[2.2.11]

Fixed

• IAP
  • Only fetch xsolla token if project id is exist
• Core
  • On debug mode, don't call xsolla config API

[2.2.10]

Added

• Ad
  • Add ads.isEnabled

[2.2.9]

Added

• IAP
  • Send custom_parameters when create order on xsolla
• Analytics
  • Add isLoggedIn and source to GameStart and GameEnd events
  • Send Purchase event for IAP Purchase to wombat
• IAP
  • Add getSupportedAPIs to check payment API when try to check IAP enabled for FB

[2.2.8]

Fixed

• Player
  • Fix unable to setData on GameSnacks for object value

[2.2.7]

Added

• Analytic
  • Add country to winningBid event

[2.2.6]

Added

• Analytic
  • Send winning bid (prebid) to wombat
• Session
  • Add source to session, e.g. web portal url

Changed

• Ad
  • Make sure to only send a highest CPM bid to server

[2.2.5]

Fixed

• Player
  • Fix error when load empty data from waves

Changed

• Ad
  • Update Prebid.js v9.11

[2.2.4]

Fixed

• Auth
  • Fix token overrided by empty string

[2.2.3]

Added

• IAP
  • Add Telegram Stars Playdeck IAP (get catalogues, get purchases, make a purchase)

[2.2.2]

Added

• Ad
  • Add custom pageUrl for AFG
  • Add source for fetching ad settings

[2.2.1]

Added

• Player
  • Cloud save for logged in user on Wortal

[2.2.0]

Added

• Player
  • Added Wortal single login from main window
• IAP
  • Wortal platform support IAP

Fixed

• Player
  • For CrazyGames isLoggedin=true if there's loggedin player
  • Auth event listener added when user open the game without login on CrazyGames and login in game
• IAP
  • Only fetching Xsolla Token for payment and IGS before calling API
  • Remove xsolla token fetching on initialization

[2.1.4] - 2024-08-01

Changed

• Ad
  • Call sandbox ad won debug mode.

[2.1.3] - 2024-07-22

Changed

• Ad
  • Call sandbox ad when there's no fill.

[2.1.2] - 2024-07-16

Fixed

• Ad
  • Fix ad error when showing non preroll ad before setup ready

[2.1.1] - 2024-07-11

Fixed

• Session
  • Fix session, game end event always send 0 timePlayed

[2.1.0] - 2024-07-11

Added

• Core
  • Integration for GameSnacks platform
  • Player authentication with Xsolla
  • Timout for ad initialization for Wortal/Telegram
• Player
  • New APIs: onLogin and isLoggedIn
• Context
  • Add Telegram share

Changed

• Player
  • Update telegram get user data

Fixed

• IAP
  • Config failing to load on CrazyGames
• Player
  • Telegram player APIs updated to new version
• Ad
  • Remove TgAdHub from ad stack

[2.0.13] - 2024-06-19

Fixed

• Player - Non-existent player data no longer throws an error on Telegram

[2.0.12] - 2024-06-13

Added

• Session
  • Audio APIs: isAudioEnabled, onAudioStatusChange

Changed

• Core
  • Legacy config APIs from Wortal 1.0 removed

[2.0.11] - 2024-06-07

Changed

• Ads
  • Debugs ads now served by Wortal sandbox

[2.0.10] - 2024-06-06

Fixed

• Ads
  • Ads errors are no longer thrown, only logged

[2.0.9] - 2024-06-06

Added

• Core
  • Event passing for QA tool
• Analytics
  • Events now tracked in FB Event Manager

[2.0.8] - 2024-05-30

Added

• Core
  • Support for local testing

[2.0.7] - 2024-05-28

Fixed

• Core
  • CrazyGames error messages now parsed correctly
• Ads
  • Sandbox ads now render in the proper location

[2.0.6] - 2024-05-22

Fixed

• IAP
  • Xsolla project ID not being set correctly

[2.0.5] - 2024-05-21

Fixed

• Core
  • Doc links in error messages

[2.0.4] - 2024-05-21

Added

• Core
  • Error tracking for reporting in dashboard

Fixed

• IAP
  • API endpoint for Xsolla params reverted to previous version

Changed

• Core
  • Reduced size of SDK

[2.0.3] - 2024-05-20

Fixed

• Ads
  • Validation for banner ads
  • Preroll ads only show on supported platforms

• Player
  • Save data is now backwards compatible with older SDK versions

[2.0.2] - 2024-05-17

Fixed

• Player
  • CrazyGames has player incorrect ID and name after login

[2.0.1] - 2024-05-15

Fixed

• Core
  • Initialization of PokiSDK failing
  • Crypto function fails in local testing if not https

[2.0.0] - 2024-05-14

BREAKING CHANGE

• Auto initialization has been removed. You must now call Wortal.initializeAsync() and Wortal.startGameAsync() manually to initialize the SDK.

Added

• Core
  • Compatibility with Wortal 2.0

• Ads
  • Custom ad server solution
  • Support for ads on Telegram

• Analytics
  • Latent event queue for tracking events from previous sessions

Fixed

• Player
  • ID incorrect on Telegram

Changed

• Core
  • Link and Viber platforms deprecated

[1.9.0] - 2024-01-11

• Core
  • Added authenticateAsync support for Wortal
• Player
  • Added saveDataAsync and loadDataAsync support for Wortal
• IAP
  • Support for Wortal and CrazyGames

[1.8.0] - 2023-11-28

Added

• Core
  • Achievements module
  • Stats module
  • Support for AddictingGames platform
  • Support for Poki platform
  • Support for Yandex platform
• IAP
  • Subscriptions on Facebook

Fixed

• Analytics
  • Duplicate logGameStart event
• Core
  • Error messages including the wrong URL
  • Possible unhandled exception when calling APIs before initialization
• IAP
  • Possible exception when calling IAP functions when IAP is not supported

[1.7.0] - 2023-11-01

BREAKING CHANGE

• NPM package/bundled SDK are no longer supported. SDK must be included at runtime via CDN.
• Patch and minor versions will no longer be offered. Please use the v1 branch for continued support.

Added

• Core
  • Tracking for SDK initialization time

Fixed

• Core
  • Initialization fails if client does not have a timezone set

Changed

• Core
  • Restructured SDK to use dynamic module imports, reducing bundle size and load times significantly
  • Improved logging and error handling

[1.6.15] - 2023-10-17

Added

• Core
  • Support for GameMonetize platform
• Ads
  • Banner ads

Fixed

• Ads
  • Missing ad unit IDs no longer cause ad calls to hang

[1.6.14] - 2023-10-13

Added

• Core
  • Support for Telegram platform

Changed

• Player
  • Default avatar is now returned if player has no photo

[1.6.13] - 2023-09-22

Added

• Core
  • Support for GamePix platform
  • onPause now triggers on all platforms

Fixed

• Core
  • Typo in event logs on GD platform

Changed

• Session
  • GameID now parsed from wortal-data.js on all platforms

[1.6.12] - 2023-09-19

Changed

• Ads
  • Disabled ad call retries on Facebook

[1.6.11] - 2023-09-19

Added

• Player
  • setDataAsync and getDataAsync are now supported on all platforms

[1.6.10] - 2023-09-13

Added

• Core
  • authenticateAsync and linkAccountAsync APIs

Changed

• Analytics
  • Analytics are no longer tracked on Game Distribution

[1.6.9] - 2023-09-11

Added

• Core
  • Support for CrazyGames platform
• Analytics
  • Tracking for game load times
• Context
  • context.switchAsync now has an optional payload
  • context.chooseAsync now supports payloads on Link

Fixed

• Ads
  • Preroll loading cover can no longer be added after initialization or when ads are blocked

Changed

• Core
  • Improved internal error handling

[1.6.8] - 2023-09-04

Added

• Core
  • Full API support in debug mode

Fixed

• Ads
  • Duplicate preroll no longer called on GD platform
• Context
  • updateAsync now adds the action and template properties to the payload if none is provided on Facebook
• Player
  • getPhoto docs now correctly state that it returns a URL and not a base64 string

Changed

• Core
  • initializeAsync and startGameAsync now work on all platforms for manual initialization
  • Validation checks now occur before platform checks in all APIs
  • Local testing no longer requires appending query params to the URL

[1.6.7] - 2023-09-01

Fixed

• Core
  • Initialization failing in GD prod environment

[1.6.6] - 2023-08-31

Fixed

• Core
  • Async calls not being awaited during initialization
• Player
  • canSubscribeBotAsync no longer returns an implicit value

[1.6.5] - 2023-08-29

Added

• Core
  • Error messages now include a URL to the relevant API docs

Fixed

• Core
  • initializeAsync now awaits the platform SDK initialization in manual mode
• Notifications
  • Notification APIs now throw an error if the ASID is missing

Changed

• IAP
  • Check for IAP support now happens earlier
• Leaderboard
  • APIs now append current context ID to leaderboard name automatically
  • APIs now throw errors if in solo context on Facebook

[1.6.4] - 2023-08-25

Added

• Ads
  • Backfill ads on Viber

Fixed

• Ads
  • Duplicate ad event fired on preroll ads

[1.6.3] - 2023-08-22

Fixed

• Core
  • Possible initialization fail when using manual initialization on Wortal/GD platforms

[1.6.2] - 2023-08-22

Fixed

• Ads
  • Game Distribution callbacks attached to wrong events

Changed

• Session
  • switchGameAsync is no longer available on Viber

[1.6.1] - 2023-08-17

Added

• Core
  • Tournament API
  • Demo project
  • Event for when SDK is initialized
  • Manual SDK initialization option
  • NPM package distribution
  • switchGameAsync API
• Ads
  • isAdBlocked API
• Session
  • getDevice, getOrientation, onOrientationChange APIs

Changed

• Core
  • Improved integration docs

[1.6.0] - 2023-08-10

Added

• Analytics
  • Events for ad calls
• IAP
  • Facebook-only properties in IAP interfaces

Fixed

• Core
  • Uncaught exceptions when validating API calls
  • Possible type mismatch in onPause argument
• Ads
  • Ad calls on Facebook no longer hang if ad unit IDs are missing
• Notifications
  • Error messages not returned on fetch fail

Changes

• Core
  • Updated Viber SDK to 1.14.0
  • Merged wortal.js into SDK for scalability
  • Improve docs and SDK logging

[1.5.0] - 2023-06-27

Added

• Core
  • Notifications API
  • Haptic feedback
  • getSupportedAPIs to check if an API is supported on current platform
• Ads
  • Retry ads on no fill
• Analytics
  • Log traffic source on initialization
  • New events: logSocialInvite, logSocialShare, logPurchase, logPurchaseSubscription
  • Additional parameters in existing events
  • Events now use Wortal Game ID instead of platform for tracking
• Context
  • inviteAsync for social invites
  • New payload types for each API

Fixed

• Ads
  • Facebook rewarded ad unit IDs not being parsed correctly
• Context
  • Facebook shareAsync error when using LocalizableContent
  • Docs contains reference to FB SDK

Changed

• Analytics
  • logGameStart and logGameEnd now marked as private
• Context
  • chooseAsync no longer requires a payload

[1.4.0] - 2023-04-24

Added

• Ads
  • Viber support
  • noFill callback for ad calls
• Context
  • Group chat context for Facebook
  • New APIs: getType, getPlayersAsync, shareLinkAsync, isSizeBetween
• Player
  • New APIs: flushDataAsync, getASIDAsync, getSignedASIDAsync, canSubscribeBotAsync, subscribeBotAsync
• Session
  • New API: getPlatform

Changed

• Core
  • Improved error handling
  • Improved docs
• Context
  • Some APIs can now return null
• Player
  • Some APIs can now return null

[1.3.0] - 2023-02-21

Added

• Core
  • Support for FB Instant Games
  • onPause callback

Fixed

• Ads
  • Possible type mismatch for ad unit IDs
• IAP
  • Typo in iap.getPurchasesAsync docs

Changed

• Analytics
  • Allow number params in analytics calls where previously only strings

[1.2.0] - 2022-12-02

Added

• Core
  • Support for Game Distribution platform
  • InitializationOptions (future use)
  • Documentation for error handling

Fixed

• Leaderboard
  • Incorrect return values
• Session
  • Possible unhandled exception in session.setSessionData

[1.1.2] - 2022-11-24

Added

• Core
  • Improved error handling with ErrorMessages
  • Increased input validation
  • Validator utils
  • Converter utils

Changed

• Core
  • Platform SDKs now rethrow errors for callers to handle

[1.1.1] - 2022-11-22

Added

• Leaderboard
  • Docs now include examples

Fixed

• Leaderboard
  • Missing return values in API calls

Changed

• Core
  • Added docs for additional types
• Context
  • API calls now only take ContextPayload parameters

[1.1.0] - 2022-11-16

Added

• Core
  • Examples in docs
• Player API
• Session API

Fixed

• Core
  • Possible duplicate init call
• Ads
  • Ad callbacks not validated
• Context
  • Possible errors from invalid payload

Changed

• Core
  • Enums to types for consistency
  • SDK namespace to API for clarity

[1.0.0] - 2022-11-15

Added

• Initial release