Every export

Check if current page is blog related

Check if current page is brands related

Check if current page is cart

Check if current page is in customer area

Check if current page is homepage

Check if current page is product detail

Check if current page is search

Get the current route ID. Used for route detection (isHome, isProduct, etc.)

Route ID constants for identifying routes throughout the application. Used for route matching, analytics, and conditional rendering based on route.

Predefined hook names for type-safe hook registration.

Hook definition with handler and priority.

Hook handler function type.

Hook handlers map for bulk registration.

Pure locale constants and helpers — no virtual modules, safe to import from Vite config context (e.g. vite plugins, head adapters).

useAsset - Hook for generating asset and CDN URLs

useAsyncFn - Hook for managing async operations with loading/error states

useComments - Hook for managing salla-comments web component re-renders

useCoupon - Hook for managing cart coupons

useDate - Hook for formatting dates

useDocumentClass - Hook for managing HTML and body element attributes

useGtm - Google Tag Manager hook for tracking events

useHook - Registers a hook handler in the hook registry

Returns true only after the component mounts on the client. Useful for avoiding hydration mismatches with browser-only APIs or web components that inject DOM content before React hydrates.

useMoney - Hook for formatting monetary values

useNumber - Hook for number formatting

useOpeningHours - Hook for checking store opening status and next open time.

usePageConfig - Centralized hook for setting salla.config.page

useProduct - Hook for managing product state with live updates

useStore - Hook for accessing and managing store state

useTheme - Hook for accessing theme configuration

Register all default hooks from theme-engine. Called automatically on module import.

HookRegistry - Manages hook handlers for the extension system

Predefined hook names for type-safe hook registration.

Simple apply/remove actions (e.g., coupon)

Base async state for operations with loading and error states

Async state with a value

State for data fetching hooks

State for data fetching with refresh capability

Hook context with full twilight context merged in. Use this type for hook handlers to get proper DX.

Hook definition with handler and priority.

Page config data structure for salla.config.set('page', ...)

Toggle actions without parameters (e.g., blog like)

Toggle actions with item parameter (e.g., wishlist item)

Hook return for apply/remove operations (coupon)

UseAssetResult - Return type for useAsset hook

UseCommentsResult - Return type for useComments hook

UseMoneyResult - Return type for useMoney hook

UseNumberResult - Return type for useNumber hook

UseProductResult - Return type for useProduct hook

UseStoreResult - Return type for useStore hook

UseThemeResult - Return type for useTheme hook

Hook return for simple toggle operations (blog like)

Hook return for toggle operations with item (wishlist, etc.)

Standard async action that returns success boolean

Standard async action with parameter

AsyncFnReturn - Return type for useAsyncFn hook

AsyncState - State type for async operations

Hook handler function type.

Hook handlers map for bulk registration.

UseBlogLikeResult - Return type for useBlogLike hook

UseCouponResult - Return type for useCoupon hook

useAsyncFn - Hook for managing async operations with loading/error states

AsyncFnReturn - Return type for useAsyncFn hook

AsyncState - State type for async operations

useStore - Hook for accessing and managing store state

UseStoreResult - Return type for useStore hook

useTheme - Hook for accessing theme configuration

UseThemeResult - Return type for useTheme hook

useMoney - Hook for formatting monetary values

UseMoneyResult - Return type for useMoney hook

useAsset - Hook for generating asset and CDN URLs

UseAssetResult - Return type for useAsset hook

useProduct - Hook for managing product state with live updates

UseProductResult - Return type for useProduct hook

useDocumentClass - Hook for managing HTML and body element attributes

useCoupon - Hook for managing cart coupons

UseCouponResult - Return type for useCoupon hook

UseBlogLikeResult - Return type for useBlogLike hook

useComments - Hook for managing salla-comments web component re-renders

UseCommentsResult - Return type for useComments hook

HookRegistry - Manages hook handlers for the extension system

Hook context with full twilight context merged in. Use this type for hook handlers to get proper DX.

useHook - Registers a hook handler in the hook registry

useGtm - Google Tag Manager hook for tracking events

CartContext - Provides cart data to hooks with `cart:*` prefix

ProductContext - Provides product data to hooks with `product:*` prefix

Overlay preview mocks onto one app's bucket (over its pristine values). Delegates to the bootstrap's `__appScopeMock`, so it works for both install paths. False if unknown/uninstalled.

Generate asset URL for local files

Builds a base {@link HeadDescriptor} with store-wide OG and Twitter defaults. Used in __root.tsx to set base metadata that can be overridden by child routes.

Builds hreflang alternate links for multilingual SEO.

Generate a CDN URL with optional image optimization

Deletes the auth `token` cookie. This cookie is written client-side by the theme (TwilightProvider), not by the SDK — `salla.cookie.clearAll()` only clears its own allowlist and leaves `token` behind — so logout must clear it here. Client-…

Create a color helper object for manipulation

Dispatch the `route::changed` Salla SDK event with the current page config.

Resolve a Salla / Laravel-style pluralized translation for a given count.

Detects the current mobile OS from the User-Agent. Returns `'other'` on the server (no `navigator`) and on desktop/unknown agents.

Get Salla SDK instance if available

Which store to ask the API about — see {@link resolveStoreIdentifier }.

Check if a URL is the placeholder image

Converts an ISO-639-1 locale string to the og:locale format (e.g. `ar` → `ar_AR`).

Merge multiple `DocumentElementDescriptor`s into React-ready props.

Merge an ordered array of `DocumentElementAttrs` into a flat `Record<string, string>`.

Declare hook slots the theme renders itself so apps may mount into them.

Picks the mobile-app store URL for the given OS: - `ios` → App Store, falling back to Google Play - `android` → Google Play, falling back to App Store - `other` → App Store, falling back to Google Play

Apply a merged attrs record to a real DOM element, tracking managed attribute names so a subsequent call cleanly removes stale values without touching attributes set by other systems.

Convert a merged attrs record (using HTML attribute names like `class`) to React JSX prop names (e.g. `class` → `className`).

One public `app.*` bucket per app, keyed by appScopeId. Everything else is read from the real `salla.config` at runtime.

Attributes to apply to a single HTML element (`<body>` or `<html>`).

Descriptor that a route or component passes to `useDocumentClass`. Each field maps to the corresponding HTML element.

Typed `<link>` descriptor — covers SEO, preload, prefetch, and resource hints.

Typed `<script>` descriptor — for injecting scripts into the document head.

Central settings context - single source of truth for all API data. Contains everything from the settings endpoint response after processing.

Typed `<style>` descriptor — for injecting inline CSS into the document head.

One app's private `app.*` bag, keyed without the `app.` prefix (`app.color` → `color`).

The visitor's mobile operating system, or `'other'` (desktop/unknown/server).

Payload dispatched via `salla.event.dispatch('route::changed', payload)` after each client-side navigation completes.

Builds a base {@link HeadDescriptor} with store-wide OG and Twitter defaults. Used in __root.tsx to set base metadata that can be overridden by child routes.

Builds hreflang alternate links for multilingual SEO.

Converts an ISO-639-1 locale string to the og:locale format (e.g. `ar` → `ar_AR`).

Typed `<link>` descriptor — covers SEO, preload, prefetch, and resource hints.

Typed `<script>` descriptor — for injecting scripts into the document head.

Typed `<style>` descriptor — for injecting inline CSS into the document head.

Predefined hook names for type-safe hook registration.

Home component data from Salla API Used by HomePage to render dynamic components

Hook definition with handler and priority.

Menu item structure from Salla API

Opening hours settings for receiving orders. Uses the Spatie\OpeningHours format (day names as keys). TODO: add to API response

Variant rows from `products/{id}/details?with[]=skus`.

Mobile app download URLs for the store

Hook handler function type.

Hook handlers map for bulk registration.

Utility type for JSON-like objects. Using `{ [key: string]: {} }` to be compatible with TanStack Router's type inference, which expects all values to be non-null.

Predefined hook names for type-safe hook registration.

Hook definition with handler and priority.

Hook handler function type.

Hook handlers map for bulk registration.

Dev-time diagnostic for the `type` field, or `null` when it is correct.

Get framework adapter by name

Read the declared theme type, tolerating any hand-edited shape.

Whether a parsed manifest declares itself a React/SSR theme.

Main Twilight Vite plugin.

Next.js framework adapter (placeholder for future implementation)

Value of `twilight.json`'s `type` for a React/SSR theme.

Framework adapter interface for extensibility

Options for Next.js router configuration (for future support)

Options for React plugin configuration

Options for TanStack Router plugin configuration

The top-level shape of `twilight.json` that the engine cares about.

Supported frameworks for twilightReact plugin

Router configuration based on framework

How a single setting/field is rendered in the dev widget.

Pure locale constants and helpers — no virtual modules, safe to import from Vite config context (e.g. vite plugins, head adapters).

Props for Category/Collection Page component

Props for HomePage component

URL query parameters for orders page

Unified loader data for all product listing pages

Static page metadata

URL query parameters — no page field, product list uses cursor-based pagination

Source configuration

Tag entity - products can be filtered by tags

URL search params for orders routes - aliases OrdersQuery

Entity union type for source metadata

Unified source type matching API sources directly

Register render-shell config for home blocks a theme owns (height, placeholder, className, id). Merges by path and overwrites existing keys, so it is safe to call more than once and idempotent for the same keys.

Props for HomePage component

Render-shell config for a home block: the values the lazy-load wrapper (`RenderWhenVisible`) needs *before* the block mounts — reserved height, the skeleton placeholder, and the wrapper's className/id.

SSR-safe loader that returns only page metadata. Cart data is fetched client-side via React Query since the cart ID lives in localStorage (unavailable during SSR).

Product List Page - Unified component for all product listing pages

Applies the `<salla-filters>` selection to the product list.

Reads the `filters[...]` selection `<salla-filters>` writes to the address bar (`filters[k]=v`, `filters[k][]=v`, `filters[k][sub]=v`) back into an object, so a filtered link can be opened directly.

Props for Category/Collection Page component

Unified loader data for all product listing pages

Static page metadata

URL query parameters — no page field, product list uses cursor-based pagination

Source configuration

Tag entity - products can be filtered by tags

Entity union type for source metadata

Unified source type matching API sources directly

URL query parameters for orders page

URL search params for orders routes - aliases OrdersQuery

URL query parameters for orders page

URL search params for orders routes - aliases OrdersQuery

TanStack Router Link adapter. Translates framework-agnostic props to TanStack Router Link props.

Read and merge `<body>` / `<html>` attributes from all currently active route matches (via `staticData.documentAttrs`).

Pure adapter: converts a `DocumentElementDescriptor` to React-ready props.

Creates and configures the TanStack Router instance for the Twilight theme.

Create a TanStack Router Link adapter component.

Creates the root route pre-configured with RouterInitialContext. beforeLoad will fetch settings/translations, loader returns serializable data.

Merge multiple `DocumentElementDescriptor`s into React-ready props.

Wraps a route module's head function for TanStack Router.

Options for creating the TanStack Router instance.

Initial router context passed from createRouter to beforeLoad.

Next.js Link adapter. Translates framework-agnostic props to Next.js Link props.

Next.js App Router document element adapter.

Merge multiple `DocumentElementDescriptor`s into React-ready props.

Apply `<body>` and `<html>` attributes directly to the DOM.

Remove all attributes previously applied by `domDocumentAdapter`.

Browser-side Sentry init for storefront themes. No-op (dead-code eliminated) unless VITE_SENTRY_DSN is set at build time.

Wrap a worker fetch handler with Sentry for a given theme. DSN from runtime SENTRY_DSN or build-time VITE_SENTRY_DSN; no-op if unset.

Lazy-loaded modal components ImageModal is lazy-loaded since it's a standalone component. Modal is kept eager because it uses compound component pattern.

Lazy-loaded cart components Use these for code-splitting cart sections

Product card layout variants - mutually exclusive

Lazy-loaded layout components Use these for code-splitting layout sections

Pushes the equal-height product card configuration to the GTM dataLayer. Mirrors PHP `HeadWidget::run()` -> `GoogleTagManager::set('equalHeight', ...)`.

Base props for layout components with children

Memoized component renderer with scroll-based lazy loading Components only mount when scrolled into view - preventing API calls until needed

Register render-shell config for home blocks a theme owns (height, placeholder, className, id). Merges by path and overwrites existing keys, so it is safe to call more than once and idempotent for the same keys.

Render-shell config for a home block: the values the lazy-load wrapper (`RenderWhenVisible`) needs *before* the block mounts — reserved height, the skeleton placeholder, and the wrapper's className/id.

Lazy-loaded common components Use these for code-splitting non-critical components

Optimized Image component with native browser lazy loading.

Framework-agnostic Link component.

Framework-agnostic Link props. Supported across TanStack Router, Next.js, and other React frameworks.

Preload behavior for Link component

Provider that configures the framework-specific Link adapter. Used internally by TwilightProvider based on client.framework setting.

NavigationInterceptor - Framework-agnostic SPA navigation interceptor.

Returns computed React prop objects for `<body>` and `<html>` built from all active `useDocumentClass` registrations.

Check if current page is blog related

Check if current page is brands related

Check if current page is cart

Check if current page is in customer area

Check if current page is homepage

Check if current page is product detail

Check if current page is search

Hook to access the Link adapter from context. Throws if used outside LinkProvider.

Get the current location (TanStack Router compatible). Reads from the router context for SSR compatibility.

Get the navigate function. Matches React Router, TanStack Router, and Remix naming convention.

Get the current route ID. Used for route detection (isHome, isProduct, etc.)

Configure navigation functions for a specific framework. Called by framework adapters during setup.

Higher-order function to create a Link component bound to a specific adapter. Useful for framework-specific exports.

Throw a notFound error. Use in route loaders. Framework adapters will override this to throw framework-specific errors.

Wraps an API promise with error handling for route loaders. On any error, logs debug info and throws notFound() for clean UX.

Wraps an API promise with error handling for authenticated route loaders. On a 401/403 response throws unauthorized(); other errors propagate.

Throw a redirect. Use in route loaders. Framework adapters will override this to throw framework-specific redirects.

Register a framework-specific document sync component. Convenience function for adding new frameworks to the registry.

Throw an unauthorized error. Use in route loaders to protect authenticated routes. Framework adapters will override this to throw framework-specific errors.

Error thrown when Link is used outside of LinkProvider

NotFound error - thrown to trigger 404

Redirect error - thrown to trigger a redirect

Unauthorized error - thrown to trigger 401

Registry for framework-specific document sync components. Each framework (tanstack, nextjs, etc.) can register its own sync component. Used by TwilightProvider to automatically apply route-based body classes.

Route ID constants for identifying routes throughout the application. Used for route matching, analytics, and conditional rendering based on route.

Generic paginated result type for API responses that work with loader functions. Matches the `ItemsLoaderFn<T>` interface expected by `ItemsList` component.

Cursor-based pagination response for paginated API endpoints.

Store API base. `VITE_API_URL` override points a preview at a branch backend; unset → prod `api.salla.dev`. Resolution order matters: the value the SSR worker resolved (published into the head, since worker `vars` are server-only `process.…

Active scope: the market plus its branch allocation, as the SDK stores it. On the client it comes from `salla.storage.get('scope')`; before the SDK hydrates storage it falls back to the `scope` cookie the theme mirrors that selection into …

{@link getActiveScope} reduced to the market id.

The auth token as the api client sees it: twilight context first, cookie/storage fallback. Use this (not `getTwilightContext().authToken`, which is often null for logged-in users — see the note above) to decide whether an authenticated-onl…

The header every Salla API call is answered by store.

Which store to ask about, in the order the answers can be trusted.

Central settings context - single source of truth for all API data. Contains everything from the settings endpoint response after processing.

List-card product for `placeholderData`. Prefers the preview key; if that was dropped on SSR dehydrate, rebuilds it from the current-scope list/wishlist.

True when this query is a list-card stand-in — skip it when dehydrating SSR.

Remember a list/card product so `product.queries.detail(id)` can use it as `placeholderData` while details load. No-op if details for this id are already cached. Themes that fetch products outside `product.list` should call this.

Default dehydrate policy (success) plus pending SSR-stream queries, minus list-card stand-ins. Replacing the default wholesale would ship error states.

A `<salla-filters>` selection, i.e. the `salla-filters::changed` payload.

One `<salla-filters>` value: a scalar, a list, or a nested `{ sub-key: value }` (variants).

Wishlist API — page-based pagination only. Kept separate from product.list to avoid mixing cursor and page pagination strategies.

Per-app public `app.*` buckets for CDN snippets, keyed by encoded app id (== `AppSnippet.id`, the `Salla.appScope` scope id). One isolated bucket per app; reads within a scope are bare `app.*`.

GoogleTagBody - Injects GTM script and noscript iframe.

Lazy-loaded GoogleTagBody component.

Lazy-loaded SiftSnippet component.

SiftSnippet - Injects Sift Science fraud detection script.

TwilightBundles - Injects twilight bundles script when custom components are detected.

Lazy-loaded StoreClosedNotification component.

StoreClosedNotification - Shows a notification bar when the store is closed.