Skip to content

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.

  • StoresynkConfig

optional cart?: StoresynkCartConfig

Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:69

StoresynkConfig.cart


optional country?: 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

pricing and cart i18n.

StoresynkConfig.country


optional customerAccountPages?: "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 points: ‘shopify’ (hosted portal) | ‘custom’.

StoresynkConfig.customerAccountPages


optional customerAccountUrl?: 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’.

StoresynkConfig.customerAccountUrl


optional customerClientId?: 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).

StoresynkConfig.customerClientId


optional customerRedirectUri?: 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.

StoresynkConfig.customerRedirectUri


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”.

StoresynkConfig.domain


optional injectRuntime?: boolean

Defined in: @storesynk/astro/dist/index.d.ts:29

Inject the @storesynk/elements runtime on every page (default true).


optional language?: 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.

StoresynkConfig.language


optional persistLocale?: "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.

StoresynkConfig.persistLocale


optional pixels?: StoresynkPixelsConfig

Defined in: .pnpm/@[email protected]_graphql@[email protected]_typescript@6.0.3/node_modules/@storesynk/core/dist/config/types.d.ts:68

StoresynkConfig.pixels


optional serverCart?: 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).

StoresynkConfig.token