CHANGELOG

[v0.21.1]

• createMatchup updated for a better flow

[v0.21.0]

• apiKey is a new required parameter used for SDK initialization

• tenantId remains a required parameter; both must be provided when instantiating LucraClient

• Corrected reference from external_id to externalId in README.md as it relates to metadata

[v0.20.2]

Added validation for metadata to ensure key/value pairs are of type string.

[v0.20.1]

Removed deprecation warning for deepLinkHandler

[v0.20.0]

Added

• New matchupDeepLinkHandler setter to configure how matchup invite URLs are generated for sharing. This provides a cleaner API specifically for matchup invitations.

• New matchupInviteUrl message type in LucraClientMessageType enum for specific matchup invitation handling

• New LucraMatchupInviteUrlBody type containing the matchupId for invite URL generation

• deepLinkHandler setter is not preferred for matchup invitations. Please migrate to matchupDeepLinkHandler for better clarity when handling matchup invitations. The old method will continue to work but matchup invitations should be handled with the new approach.

Matchup Invitation - Migration Guide

Before:

lucraClient.deepLinkHandler = ({ url }) => {
  // Had to parse the Lucra URL to extract matchupId
  const lucraUrl = new URL(url);
  const matchupId = lucraUrl.pathname.split("/").pop();

  const shareUrl = `${window.location.origin}?matchupId=${matchupId}`;
  lucraClient.sendMessage.deepLinkResponse({ url: shareUrl });
};

After (Recommended):

lucraClient.matchupDeepLinkHandler = (matchupId) => {
  // Receive matchupId directly, just return the URL
  return Promise.resolve(`${window.location.origin}?matchupId=${matchupId}`);
};

Key Benefits:

• Receive matchupId string directly without URL parsing

• Simply return the URL string - response sent automatically

• No need to manually call deepLinkResponse()

• More explicit method name for matchup invitations

• Cleaner, more maintainable code

• Better TypeScript support

See README.md for complete migration guide and usage examples.

[v0.19.0]

Updated

• The sendMessage.userUpdated method can now include valid JSON as part of the metadata property on the payload. This metadata will be returned on the user object (see SDKLucraUser/SDKClientUser types).

[v0.18.0]

Updated

• LucraClient now allows registering a custom activeMatchupStarted handler to know when (non-creator) matchup participants have seen the matchup start in real time while viewing the matchup details page

[v0.17.0]

Updated

• LucraClient now allows registering a custom exitLucraHandler to know when a user has attempted to exit the Lucra experience

[v0.16.0]

Updated

• LucraClient constructor now accepts locationId to set the location without having to navigate to home

• LucraClient constructor has deprecated useTestUsers as its now no longer needed to log in with test users

• Calling .open on the LucraClient when it's already open will perform a redirect instead of incorrectly adding another iframe

• New loginSuccess callback that receives the user info. Wait for this callback to fire before sending any messages to LucraClient

[v0.15.1]

Updated

• allow payment on iframe

[v0.15.0]

Updated

• matchupStarted new onMessage event that fires when the matchup owner starts a GYP matchup

[v0.14.0]

Updated

• logout method now available on the LucraClient

[v0.13.1]

Updated

• LucraClientConstructor now allows for using test users via useTestUsers property

[v0.13.0]

Updated

• availableRewards message to send to Lucra if Free To Play is enabled

• claimReward message from Lucra if a user is redeeming a Free To Play reward

• matchupDetails navigation method no longers accepts a teamInviteId as the updated models allow for the user to select their team

[v0.12.3]

• add support for passing a 10-digit phone number to prefill and auto-send verification SMS

[v0.12.1]

Updated

• redirect method to redirect an already opened LucraClient

[v0.12.0]

Updated

• home now accepts a locationId parameter to skip the location picker

• all types now come from /types/types.js

[v0.11.2]

Updated

• navigationEvent event with the full url that can be used in the future for deepLinking

[v0.11.1]

Updated

• tournamentJoined event

• tournamentDetails open method

[v0.11.0]

Updated

• Fixed imports for non-Bun packages

[v0.10.13]

Updated

• Update to exports

[v0.10.12]

Updated

• Update to exports

[v0.10.11]

Updated

• Update to exports

[v0.10.10]

Updated

• Update to exports

[v0.10.9]

Updated

• Update to exports

[v0.10.8]

Updated

• exports in package.json

[v0.10.7]

Updated

• Expose typescript types

[v0.10.6]

Updated

• Expose typescript types

[v0.10.5]

Updated

• Update the dist folder

[v0.10.4]

Updated

• Deep linking not setting the parentUrl

[v0.10.3]

Added

• Updated iframe permissions to allow accelerometer, bluetooth, and gyroscope access

[v0.10.2]

Added

• hideNavigation param if there is a gameId present when calling the LucraClient's createMatchup method

[v0.10.1]

Updated

• deepLink body is now a full URL that can should be passed into the open.deepLink method

[v0.10.0]

Updated

• New set methods for registering handler functions after instantiation of LucraClient

• iframe now allows for web-share

[v0.9.0]

Updated

• deepLink message now accepted

[v0.8.3]

Updated

• theme optional on LucraConvertToCreditResponse

[v0.8.2]

Updated

• LucraConvertToCreditResponse updated

[v0.8.1]

Updated

• new matchupDetails method to navigate to an existing matchup to accept

[v0.8.0]

Updated

• updates to the .open method

[v0.7.3]

Updated

• new enableConvertToCredit message to send to Lucra

[v0.7.2]

Updated

• new convertToCredit messages that support withdrawing funds as credit

• open now has typed methods for where to open Lucra

[v0.6.1]

Updated

• fix typo

[v0.6.0]

Updated

• LucraSports -> LucraClient

[v0.5.2]

Updated

• remove hostUrl from the constructor

[v0.5.1]

Updated

• remove need for hostUrl in the constructor

• fix too early of setting up event listener

[0.5.0]

Updated

• .open method now contains the destination instead of the constructor, allowing you to determine where to open LucraSports at a later time

[0.4.0]

Changed

• updated to all the supported events and bugfixes

[0.3.0]

Changed

• constructor takes new parameters for Lucra url

[v0.2.4]

Added

• matchupCanceled and matchupCompleted events

[v0.2.3]

Added

• default matchupId parameter to navigate directly to the wager page

Fixed

• login event should the Lucra User Id as the parameter

[v0.2.2]

Fixed

• Include dist folder for releases

[v0.2.1]

Fixed

• Include dist folder for releases

[v0.2.0]

Fixed

• Include dist folder for releases

[v0.1.0]

Added

Fixed

Updated

[v0.0.1]

Added

• Initial package

Fixed

Updated