StoresynkOptions
Defined in: @storesynk/astro/dist/index.d.ts:27
Astro integration options - the one shared StoresynkConfig (see
@storesynk/core: connection / locale / customer-account fields + the pixels
/ cart behavior groups), the same shape the Next binding and the no-build
data-storesynk-config JSON block use, plus one Astro-specific field,
injectRuntime. The app metafield namespace is NOT here: it’s hard-coded for
now (see APP_NAMESPACE in runtime.ts), injected by getConfig, not
user-configurable - same as @storesynk/next.
Extends
Section titled “Extends”StoresynkConfig
Properties
Section titled “Properties”
optionalcart?:StoresynkCartConfig
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:69
Inherited from
Section titled “Inherited from”StoresynkConfig.cart
country?
Section titled “country?”
optionalcountry?:string
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:52
Default country (ISO) for
In Context
Section titled “In Context”pricing and cart i18n.
Inherited from
Section titled “Inherited from”StoresynkConfig.country
customerAccountPages?
Section titled “customerAccountPages?”
optionalcustomerAccountPages?:"shopify"|"custom"
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:65
Where
Inherited from
Section titled “Inherited from”StoresynkConfig.customerAccountPages
customerAccountUrl?
Section titled “customerAccountUrl?”
optionalcustomerAccountUrl?:string
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:67
Account destination URL. Required when customerAccountPages is ‘custom’.
Inherited from
Section titled “Inherited from”StoresynkConfig.customerAccountUrl
customerClientId?
Section titled “customerClientId?”
optionalcustomerClientId?:string
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:60
Customer Account API client id (shp_…). Presence enables the customers
module (login, show-customer-*, cart buyer identity).
Inherited from
Section titled “Inherited from”StoresynkConfig.customerClientId
customerRedirectUri?
Section titled “customerRedirectUri?”
optionalcustomerRedirectUri?:string
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:63
OAuth callback URL for customer login (must be allow-listed). Default: the page login starts from.
Inherited from
Section titled “Inherited from”StoresynkConfig.customerRedirectUri
domain
Section titled “domain”domain:
string
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:48
myshopify domain or full origin, e.g. “shop.myshopify.com”.
Inherited from
Section titled “Inherited from”StoresynkConfig.domain
injectRuntime?
Section titled “injectRuntime?”
optionalinjectRuntime?:boolean
Defined in: @storesynk/astro/dist/index.d.ts:29
Inject the @storesynk/elements runtime on every page (default true).
language?
Section titled “language?”
optionallanguage?:string
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:54
Default language (ISO) for cart i18n.
Inherited from
Section titled “Inherited from”StoresynkConfig.language
persistLocale?
Section titled “persistLocale?”
optionalpersistLocale?:"localStorage"|"cookie"|"none"
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:57
How the buyer’s locale choice persists. Default ‘cookie’ - server-readable, so SSR routes can render the buyer’s market.
Inherited from
Section titled “Inherited from”StoresynkConfig.persistLocale
pixels?
Section titled “pixels?”
optionalpixels?:StoresynkPixelsConfig
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:68
Inherited from
Section titled “Inherited from”StoresynkConfig.pixels
serverCart?
Section titled “serverCart?”
optionalserverCart?:boolean
Defined in: @storesynk/astro/dist/index.d.ts:37
Server-owned cart: the cart id lives in an HttpOnly shopify_cartId
cookie the browser never reads, and every cart operation round-trips
through an injected /_storesynk/cart endpoint (SSR/hybrid deployments
only - the endpoint is prerender = false). The standard-actions
protocol is untouched; only the I/O moves server-side.
token:
string
Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:50
Public Storefront API access token (browser-safe - never an Admin token).
Inherited from
Section titled “Inherited from”StoresynkConfig.token