Application Load
IAppLoadCommon
The physical TypeScript declaration from the Nuxt starter, with linked types and field comments.
IAppLoadCommonShared storefront settings and initial content.
interfaces/orionplace/appBase/IAppLoadCommon.tsexport interface IAppLoadCommon {
// Available languages and their default currency and units.
locale: Record<string, IAppLoadCommonLocale>;
// Currencies, formatting rules, conversion values and selector availability.
currencies: Record<string, IAppLoadCommonCurrency>;
// Weight units and conversion factors.
weights: Record<string, IAppLoadCommonUnit>;
// Length units and conversion factors.
lengths: Record<string, IAppLoadCommonUnit>;
// Whether a geocoding plugin is selected for address lookup by coordinates.
// Address and city text suggestions depend on the country.
geo_location_enabled: boolean;
/** ISO codes of the shop's shipping countries, sorted. */
shipping_countries?: string[];
// Whether the current session belongs to a signed-in customer.
is_authenticated: boolean;
// Customer balance by currency, when a wallet is available.
wallet?: Record<string, IAppLoadCommonWalletValue>;
// Logo sizes and favicon.
logos: IAppLoadCommonLogos;
// Public keys for external integrations, including the Yandex Maps API key.
public_keys: Record<string, string>;
// Default map center coordinates configured for the storefront.
default_map: IGeoCoordinates;
// Store home-page metadata
seo?: IAppLoadCommonSeo[];
// Social network links.
sm?: IAppLoadCommonSocial[];
// Initial cart and wishlist counters and feature defaults.
variables?: IAppLoadCommonVariables;
// Company name, contact details and legal information.
contact?: IAppLoadCommonContact;
// Display options for menus, lists and storefront elements.
visual_settings?: IAppLoadCommonVisualSettings;
// Events and messages displayed in the storefront.
events?: IAppLoadCommonEvents[];
// Banner collections for the homepage.
main_banner?: Record<string, IAppLoadCommonBanner[]>;
// Category tree for storefront navigation.
catalog?: ICategory[];
// Initial storefront products. Each entry contains `seller_id`; read the full
// seller from `sellers`.
products?: IAppLoadProduct[];
// Personalized products based on previous searches and categories. Each entry
// contains `seller_id`; read the full seller from `sellers`. Empty for guests.
featured?: IAppLoadProduct[];
// Seller details keyed by seller ID. Product stores use this object to provide
// `IProduct.seller` to components.
sellers: Record<string, IProductSeller>;
// Localized suggestions for the search input.
search_hints?: Record<string, string>[];
// Plans this storefront sells, with their prices and options, as in
// `subscriptions_guest_search`. A storefront without a plan list gets an empty
// `data` list.
tariffs?: IAppLoadCommonTariff;
}