Client Exports

---@return table
local config = exports["lb-phone"]:GetConfig()

---@return vector3[]
local cellTowers = exports["lb-phone"]:GetCellTowers()

---@param number string # The number to format
---@return string # The formatted number
local formattedNumber = exports["lb-phone"]:FormatNumber(number)

---@param link string # The link to the image/video
exports["lb-phone"]:SaveToGallery(link)

---@param number? string
---@return boolean
local hasPhone = exports["lb-phone"]:HasPhoneItem(number)

---@alias CheckEvent "openPhone" | "playNativePhoneSound"
 
---@param event CheckEvent
---@param handler fun(...: any): boolean
---@return number id
local id = exports["lb-phone"]:AddCheck(event, handler)

---@param id number
---@return boolean success
local success = exports["lb-phone"]:RemoveCheck(id)

---@return string?
local phoneNumber = exports["lb-phone"]:GetEquippedPhoneNumber()

---@param open? boolean # If true, the phone is opened, if false, the phone is closed. If nil, the phone it toggles.
---@param noFocus? boolean # If true, the cursor is hidden when opening the phone.
exports["lb-phone"]:ToggleOpen(open, noFocus)

---@return boolean
local isOpen = exports["lb-phone"]:IsOpen()

---@return boolean
local isPhoneOnScreen = exports["lb-phone"]:IsPhoneOnScreen()

---@return boolean
local isDisabled = exports["lb-phone"]:IsDisabled()

---@param disabled boolean
exports["lb-phone"]:ToggleDisabled(disabled)

---@param amount? number # How much of the phone to show, 0-100. Defaults to 25
exports["lb-phone"]:SetPhonePartiallyVisible(amount)

---@param show boolean
exports["lb-phone"]:ToggleHomeIndicator(show)

---@param landscape boolean
exports["lb-phone"]:ToggleLandscape(landscape)

---@class NotificationButton
---@field title string
---@field event? string # The event to trigger when the button is pressed
---@field server? boolean # Whether the event is server-side
---@field data any # Data to send to the event
---@field remove? boolean # Remove the notification after the button is pressed
 
---@class NotificationData
---@field app? string # Identifier of the app that sent the notification
---@field title? string # Title of the notification
---@field content? string # Content of the notification
---@field thumbnail? string # Thumbnail URL
---@field avatar? string # Avatar URL
---@field showAvatar? boolean # Whether to show an avatar placeholder if no avatar was sent
---@field icon? string # Icon URL, only used if no app is set
---@field customData? { buttons?: NotificationButton[] }
 
---@param data NotificationData
exports["lb-phone"]:SendNotification({
    app = "Settings",
    title = "Test",
    content = "This is a test notification",
})

---@param notificationId number | string
---@return boolean success
local success = exports["lb-phone"]:DeleteNotification(notificationId)

---@param flashlight boolean
exports["lb-phone"]:ToggleFlashlight(flashlight)

---@return boolean
local flashlightEnabled = exports["lb-phone"]:GetFlashlight()

---@param bars? number | false
exports["lb-phone"]:SetServiceBars(bars)

exports["lb-phone"]:ReloadPhone()

---@param variation number # The variation of the phone, has to be configured in `Config.Item.Names`
exports["lb-phone"]:SetPhoneVariation(variation)

---@class PhoneAnimationData
---@field dict string
---@field anim string
---@field flag number
---@field blendInSpeed? number
---@field blendOutSpeed? number
 
---@class PhoneAnimation
---@field open PhoneAnimationData
---@field base PhoneAnimationData
---@field close PhoneAnimationData
 
---@class PhoneAnimations
---@field onFoot PhoneAnimation
---@field inVehicle PhoneAnimation
 
---@class PhoneAnimationConfig
---@field default PhoneAnimations
---@field call PhoneAnimations
---@field camera PhoneAnimations
 
---@type PhoneAnimationConfig
local animations = PhoneAnimations["two handed"]
 
exports["lb-phone"]:SetAnimations(animations)

exports["lb-phone"]:ResetAnimations()

---@param selfieMode? boolean
exports["lb-phone"]:EnableWalkableCam(selfieMode)

exports["lb-phone"]:DisableWalkableCam()

---@return boolean
local enabled = exports["lb-phone"]:IsWalkingCamEnabled()

---@param selfieMode boolean
exports["lb-phone"]:ToggleSelfieCam(selfieMode)

exports["lb-phone"]:ToggleCameraFrozen()

---@return boolean
local selfieCam = exports["lb-phone"]:IsSelfieCam()

---@return boolean
local cameraOpen = exports["lb-phone"]:IsCameraOpen()

---@return table?
local settings = exports["lb-phone"]:GetSettings()

---@return boolean?
local airplaneMode = exports["lb-phone"]:GetAirplaneMode()

---@return boolean?
local streamerMode = exports["lb-phone"]:GetStreamerMode()

---@class KeyBindOptions
---@field name string
---@field description string # The description shown in the keybind settings
---@field defaultKey string
---@field defaultMapper? string # Defaults to "keyboard"
---@field secondaryKey? string
---@field secondaryMapper? string # Defaults to defaultMapper
---@field onPress? fun()
---@field onRelease? fun(timePressed: integer) # timePressed is in milliseconds
 
---@class KeyBind : KeyBindOptions
---@field defaultMapper string
---@field pressed boolean
---@field startedPressing integer
---@field disabled boolean
---@field hash integer
---@field hex string
---@field instructional string # Can be used to show the key in help text
 
---@param options KeyBindOptions
---@return KeyBind
local keyBind = exports["lb-phone"]:AddKeyBind({
    name = "my_keybind",
    description = "My keybind",
    defaultKey = "F5",
    onPress = function()
        print("Pressed")
    end,
    onRelease = function(timePressed)
        print("Released after " .. timePressed .. "ms")
    end
})

---@class MusicTrayHandlers
---@field action? fun(action: string, data?: any)
---@field play? fun()
---@field pause? fun()
---@field next? fun()
---@field previous? fun()
---@field seek? fun(position: number)
 
---@class MusicTrayPermissions
---@field seek? boolean
---@field next? boolean
---@field previous? boolean
 
---@class MusicTrayOptions
---@field id? string
---@field title string
---@field artist? string
---@field album? string
---@field cover? string
---@field duration? number
---@field position? number
---@field playing? boolean
---@field color? string
---@field permissions? MusicTrayPermissions
---@field handlers? MusicTrayHandlers
 
---@type MusicTrayOptions
local options = {
    title = "Track name",
    artist = "Artist",
    duration = 180,
    position = 0,
    playing = true,
    permissions = {
        seek = true,
        next = true,
        previous = true
    },
    handlers = {
        pause = function()
            -- Pause playback
        end,
        seek = function(position)
            -- Seek to position in seconds
        end
    }
}
 
---@type string | false
local id, errorReason = exports["lb-phone"]:ShowMusicTray(options)

---@param id string
---@param patch table
---@return boolean success
---@return string? errorReason
local success, errorReason = exports["lb-phone"]:UpdateMusicTray(id, {
    position = 30,
    playing = false
})
 
-- A single property can also be updated
exports["lb-phone"]:UpdateMusicTray(id, "playing", true)

---@param id? string
---@return boolean success
---@return string? errorReason
local success, errorReason = exports["lb-phone"]:RemoveMusicTray(id)

---@class LiveTrayButton
---@field id string
---@field label? string
---@field icon? string
---@field color? "red" | "green" | "blue" | "black" | string
---@field click? fun()
 
---@class LiveTrayEmbed
---@field url? string # Provide either url or html
---@field html? string # Provide either html or url
---@field size 3 | 4 | 5
 
---@class LiveTrayHandlers
---@field action? fun(action: string, data?: any)
---@field tap? fun()
---@field remove? fun()
---@field autoHide? fun()
---@field update? fun(patch: table)
 
---@class LiveTrayOptions
---@field icon? string
---@field title string
---@field text? string
---@field color? string
---@field progress? number
---@field badge? string
---@field expandable? boolean
---@field buttons? LiveTrayButton[]
---@field duration? number
---@field removable? boolean
---@field embed? LiveTrayEmbed
---@field handlers? LiveTrayHandlers
 
---@type LiveTrayOptions
local options = {
    icon = "https://example.com/icon.png",
    title = "Delivery in progress",
    text = "2 minutes away",
    progress = 0.75,
    removable = true,
    buttons = {
        {
            id = "cancel",
            label = "Cancel",
            color = "red",
            click = function()
                -- Cancel the delivery
            end
        }
    }
}
 
---@type string | false
local id, errorReason = exports["lb-phone"]:ShowLiveTray(options)

---@param id string
---@param patch table
---@return boolean success
---@return string? errorReason
local success, errorReason = exports["lb-phone"]:UpdateLiveTray(id, {
    text = "1 minute away",
    progress = 0.9
})
 
-- A single property can also be updated
exports["lb-phone"]:UpdateLiveTray(id, "badge", "Almost there")

---@param id? string
---@return boolean success
---@return string? errorReason
local success, errorReason = exports["lb-phone"]:RemoveLiveTray(id)

---@return boolean
local isLive = exports["lb-phone"]:IsLive()

---@class BirdyPostData
---@field content string # The content of the post
---@field attachments? string[] # URLs of the attachments
---@field replyTo? string # The ID of the post to reply to
---@field hashtags? string[] # Hashtags used in the post
 
---@param data BirdyPostData
---@return boolean # Whether the post was successful
exports["lb-phone"]:PostBirdy(data)

---@class ContactData
---@field number string
---@field firstname string
---@field lastname? string
---@field avatar? string
---@field email? string
---@field address? string
 
---@param data ContactData
---@return boolean success
exports["lb-phone"]:AddContact({
    number = "01234567890",
    firstname = "John",
    lastname = "Doe",
    avatar = "https://example.com/avatar",
    email =  "[email protected]",
    address = "Eclipse Towers, Penthouse Suite 1",
})

---@class UpdateContactData : ContactData
---@field oldNumber? string
 
---@param data UpdateContactData
---@return boolean success
local success = exports["lb-phone"]:UpdateContact({
    oldNumber = "01234567890",
    number = "09876543210",
    firstname = "John",
    lastname = "Doe"
})

---@param phoneNumber string
---@return boolean success
local success = exports["lb-phone"]:RemoveContact(phoneNumber)

---@param app string # The app (identifier) to open
---@param data? table # Data to pass to the app
exports["lb-phone"]:OpenApp(app, data)

---@param options? { app?: string, closeCompletely?: boolean }
exports["lb-phone"]:CloseApp(options)

---@param app string
---@param hidden boolean
exports["lb-phone"]:SetAppHidden(app, hidden)

---@param app string
---@param installed boolean
exports["lb-phone"]:SetAppInstalled(app, installed)

---@class CustomApp
---@field identifier string # A unique identifier of the app
---@field ui? string # The path to the HTML file, including the resource name
---@field name string
---@field description string
---@field images? string[] # An array of images for the app on the app store
---@field developer? string # The developer of the app
---@field defaultApp? boolean # If set to true, the app will be added automatically
---@field size? number # Size in kB
---@field icon? string # A url to the icon of the app
---@field price? number # Require players to purchase the app with in-game money
---@field landscape? boolean
---@field game? boolean
---@field disableInAppNotifications? boolean
---@field onDelete? fun() # Called when the app is uninstalled
---@field onInstall? fun() # Called when the app is installed
---@field onUse? fun() # Called when the app is opened
---@field fixBlur? boolean # If set to true, the app will not be blurry. This requires you to use the em/rem units in your CSS
---@field onClose? fun() # Called when the app is closed
---@field onOpen? fun() # Called when the app is opened
 
---@param appData CustomApp
---@return boolean success
---@return string? errorMessage
local success, errorMessage = exports["lb-phone"]:AddCustomApp({
    identifier = "custom-app",
    name = "Custom App",
    description = "This is a custom app",
    ui = GetCurrentResourceName() .. "/ui/index.html"
})

---@param identifier string
---@return boolean success
---@return string? errorMessage
local success, errorMessage = exports["lb-phone"]:RemoveCustomApp(identifier)

---@param identifier string
---@param data any
---@return boolean success
---@return string? errorMessage
exports["lb-phone"]:SendCustomAppMessage(identifier, data)

---@class PopUpInput
---@field type? string # The HTML input type, e.g. "text" or "number"
---@field placeholder? string
---@field defaultValue? string
---@field minLength? number
---@field maxLength? number
---@field min? number
---@field max? number
---@field minCharacters? number # Disables the second button until the input has at least this many characters
---@field maxCharacters? number # Disables the second button if the input has more characters than this
---@field onChange? fun(value: string)
 
---@class PopUpButton
---@field title string
---@field color? "blue" | "red" | "green" | "yellow" # Defaults to blue
---@field bold? boolean
---@field disabled? boolean
---@field cb? fun()
 
---@class PopUp
---@field title string
---@field description? string
---@field vertical? boolean # Stack the buttons vertically
---@field attachment? { src: string }
---@field input? PopUpInput
---@field inputs? PopUpInput[]
---@field buttons PopUpButton[] # At least one button is required
 
---@param data PopUp
exports["lb-phone"]:SetPopUp({
    title = "Popup",
    description = "Confirm your choice",
    buttons = {
        {
            title = "Cancel",
            color = "red",
            cb = function()
                print("Cancel")
            end
        },
        {
            title = "Confirm",
            color = "blue",
            cb = function()
                print("Confirm")
            end
        }
    }
})

---@class ContextMenuButton
---@field title string
---@field color? "blue" | "red" # Defaults to blue
---@field disabled? boolean
---@field cb fun()
 
---@class ContextMenu
---@field title? string
---@field buttons ContextMenuButton[] # At least one button is required
 
---@param data ContextMenu
exports["lb-phone"]:SetContextMenu({
    title = "Context menu",
    buttons = {
        {
            title = "Option 1",
            cb = function()
                print("Option 1")
            end
        },
        {
            title = "Option 2",
            color = "red",
            cb = function()
                print("Option 2")
            end
        }
    }
})

---@param options { component: "gallery" | "gif" | "emoji" | "camera" | "colorpicker" | "contactselector", [string]: any } # The component to show and its options
---@param cb fun(result: any) # Callback function with the result
exports["lb-phone"]:ShowComponent({
    component = "gallery", -- component to show
    -- other options
    includeVideos = true,
    includeImages = true
}, function(media)
    print("Selected media:", media.src)
end)

---@class CameraComponentData
---@field default? { type?: "Photo" | "Video" | "Landscape", flash?: boolean, camera?: "rear" | "front" } # Defaults to a photo without flash using the rear camera
---@field permissions? { toggleFlash?: boolean, flipCamera?: boolean, takePhoto?: boolean, takeVideo?: boolean, takeLandscapePhoto?: boolean } # Everything is allowed by default
---@field saveToGallery? boolean # Defaults to true
 
---@param data? CameraComponentData
---@param cb? fun(url: string)
---@return string? url # Only returned if no callback is provided
local url = exports["lb-phone"]:SetCameraComponent({
    default = {
        type = "Photo",
        camera = "front"
    },
    permissions = {
        takeVideo = false
    },
    saveToGallery = false
})

---@param phoneNumber string
exports["lb-phone"]:SetContactModal(phoneNumber)

---@return boolean # If the phone has 0% battery
local dead = exports["lb-phone"]:IsPhoneDead()

---@return number # The battery percentage, 0-100
local battery = exports["lb-phone"]:GetBattery()

---@param battery number # The battery percentage, 0-100
exports["lb-phone"]:SetBattery(battery)

---@param charging boolean
exports["lb-phone"]:ToggleCharging(charging)

---@return boolean
local charging = exports["lb-phone"]:IsCharging()

---@param company string # The company to send the message to
---@param message string
---@param anonymous? boolean # Whether the message should be sent anonymously
---@return number? messageId
local messageId = exports["lb-phone"]:SendCompanyMessage(company, message, anonymous)

---@param company string # The company to send the message to
---@param coords? vector3 # The coordinates to send, if not provided it will send the player's current location
---@param anonymous? boolean # Whether the message should be sent anonymously
---@return number? messageId
local messageId = exports["lb-phone"]:SendCompanyCoords(company, coords, anonymous)

---@return boolean
local callsEnabled = exports["lb-phone"]:GetCompanyCallsStatus()

---@param enabled boolean
---@return boolean # Whether company calls are enabled
local callsEnabled = exports["lb-phone"]:ToggleCompanyCalls(enabled)

---@alias CryptoCoinPermissions { buy?: boolean, sell?: boolean, transfer?: boolean }
 
---@class CryptoCoin
---@field id string
---@field name string
---@field symbol string
---@field image string
---@field current_price number
---@field prices number[]
---@field change_24h number
---@field permissions? CryptoCoinPermissions
 
---@class OwnedCryptoCoin : CryptoCoin
---@field owned? number
---@field invested? number

---@param coin string
---@return number?
local value = exports["lb-phone"]:GetCoinValue(coin)

---@return OwnedCryptoCoin[]
local wallet = exports["lb-phone"]:GetCryptoWallet()

---@param coin string
---@return OwnedCryptoCoin?
local coinData = exports["lb-phone"]:GetOwnedCoin(coin)

---@class CallOptions
---@field number? string
---@field company? string
---@field videoCall? boolean
---@field hideNumber? boolean # Defaults to the player's caller ID setting
 
---@param options CallOptions
exports["lb-phone"]:CreateCall(options)

---@return boolean
local inCall = exports["lb-phone"]:IsInCall()

---@class IncomingCall
---@field id string
---@field number string # The number that was called
---@field accept fun()
---@field deny fun() # Declines/ends the call without triggering onEnd
---@field setName fun(name: string)
---@field hasEnded fun(): boolean
 
---@class CustomNumberData
---@field onCall fun(incomingCall: IncomingCall)
---@field onEnd? fun()
---@field onAction? fun(action: "mute" | "unmute" | "enable_speaker" | "disable_speaker")
---@field onKeypad? fun(key: string)
 
---@param number string
---@param data CustomNumberData
---@return boolean success
---@return string? reason
local success, reason = exports["lb-phone"]:CreateCustomNumber(number, data)

---@param number string
---@return boolean success
---@return string? reason
local success, reason = exports["lb-phone"]:RemoveCustomNumber(number)

---@param validator fun(phoneNumber: string): boolean
---@param data CustomNumberData
---@return number
local id = exports["lb-phone"]:CreateDynamicCustomNumber(validator, data)

---@param id number
---@return boolean success
---@return string? reason
local success, reason = exports["lb-phone"]:RemoveDynamicCustomNumber(id)

---@return boolean
local success = exports["lb-phone"]:EndCustomCall()

---@param event string
---@param handler fun(...) : ...
exports["lb-phone"]:RegisterClientCallback(event, handler)

---@param event string
---@param ... any
---@return ... any
local data = exports["lb-phone"]:AwaitCallback(event, ...)

---@param event string
---@param cb? fun(...)
---@param ... any
exports["lb-phone"]:TriggerCallback(event, function(data)
    print(data)
end, ...)