Skip to content

Context

SDK exports context types:

ts
import type {
  FrameContext,
  AuthContext,
  AccountContext,
  AppContext,
  PlacementContext,
  RateLimitContext
} from '@aspro-cloud/miniapp-jssdk'

Types

FrameContext

Main application context object returned by the Frame.getContext() method

PropertyTypeDescription
httpsbooleanSecure connection protocol is used
languagestringInterface language ('ru', 'en', etc.)
domainstringDomain of the current Аспро.Cloud account where the application is opened
accountAccountContextCurrent account data
appAppContextApplication and version data
authAuthContextCurrent authorized user data (OAuth2 tokens)
placementPlacementContextCurrent embedding placement data in the platform interface
ratelimitRateLimitContextAPI request limit data
[key: string]anyAdditional data

AccountContext

Current Аспро.Cloud account data where the application is opened

PropertyTypeDescription
idstringAccount identifier

AppContext

Application and version data

PropertyTypeDescription
idstringApplication identifier
versionstringApplication version installed on the account (1.0.0, 0.2.100, etc.)

AuthContext

Current authorized user data

PropertyTypeDescription
access_tokenstringUser's OAuth2 access token
refresh_tokenstringUser's OAuth2 refresh token
expires_atstringAccess token expiration date and time 2026-04-01 10:15:20

PlacementContext

Current embedding placement data in the platform interface

PropertyTypeDescription
idstringEmbedding placement identifier from the application version manifest
codestringEmbedding type code (app.homepage, header.widget, etc.)
propsobjectAdditional embedding placement parameters from the application version manifest

RateLimitContext

Application API request limit data

PropertyTypeDescription
limitnumberMaximum number of requests per second

Published under the MIT license.