@scayle/storefront-nuxt 8.44.2 → 8.45.1

package/CHANGELOG.md

@@ -1,5 +1,92 @@
 # @scayle/storefront-nuxt
 
+## 8.45.1
+
+### Patch Changes
+
+- Updated dependency `@vercel/nft@0.30.2` to `@vercel/nft@0.30.3`
+- Updated SCAYLE Resource Center references
+
+**Dependencies**
+
+- Updated dependency to @scayle/unstorage-compression-driver@1.2.1
+
+**@scayle/storefront-core v8.45.1**
+
+- Patch
+  - Updated SCAYLE Resource Center references
+
+## 8.45.0
+
+### Minor Changes
+
+- The API routes structure was updated for multi-shop environments. The `apiBasePath` option was removed from per-shop configuration but remains configurable at the module level.
+
+  NOTE: Update your `nuxt.config.ts` to ensure `routeRules` for `/api/**` uses the manually set `apiBasePath` value to prevent caching issues with session-related RPC's and potentially failing requests!
+
+  **Before (per-shop apiBasePath):**
+
+  ```typescript
+  // This configuration is no longer supported
+  runtimeConfig: {
+    storefront: {
+      shops: {
+        1001: {
+          shopId: 1001,
+          path: 'de',
+          apiBasePath: '/custom-api', // ❌ No longer supported
+          // ... other shop config
+        },
+        1002: {
+          shopId: 1002,
+          path: 'en',
+          apiBasePath: '/different-api', // ❌ No longer supported
+          // ... other shop config
+        }
+      }
+    }
+  }
+  ```
+
+  **After (module-level apiBasePath):**
+
+  ```typescript
+  // nuxt.config.ts
+  export default defineNuxtConfig({
+    storefront: {
+      apiBasePath: '/custom-api', // ✅ Configure globally for all shops
+    },
+    runtimeConfig: {
+      storefront: {
+        shops: {
+          1001: {
+            shopId: 1001,
+            path: 'de',
+            // ✅ apiBasePath removed from shop config
+            // ... other shop config
+          },
+          1002: {
+            shopId: 1002,
+            path: 'en',
+            // ✅ apiBasePath removed from shop config
+            // ... other shop config
+          },
+        },
+      },
+    },
+  })
+  ```
+
+  Additionally, the types for the Storefront module options and Storefront runtime configuration have been cleaned up to properly reflect which settings can be set at runtime and which cannot. This clarifies the distinction between configuration that is static (set at build/module level) and configuration that is dynamic (set at runtime), improving type safety and developer experience.
+
+### Patch Changes
+
+**Dependencies**
+
+**@scayle/storefront-core v8.45.0**
+
+- No changes in this release.
+
 ## 8.44.2
 
 ### Patch Changes
@@ -1960,7 +2047,7 @@
   Legacy configuration options `provider` and `redis` configuration are no longer supported and have been deprecated since Storefront Boilerplate v1.0.0-rc.05.
 
   You'll need to migrate your existing storage settings to the new `storefront.storage` format.
-  Check the [SCAYLE Resource Center](https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#storage) for more details.
+  Check the [SCAYLE Resource Center](https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/storage) for more details.
 
   - _No Longer Supported: Legacy Storage Setup in (`nuxt.config.ts`):_
 
@@ -2164,7 +2251,7 @@
 
 - **\[💥 BREAKING\]** The `store` option in the module configuration has been removed. `@scayle/storefront-nuxt@7.84.0` introduced the `shops` option as a replacement, but maintained backward compatibility with the `store` option. Going forward, configuring shops must be done using the `shops` keyword.
 
-  - For more information, please refer to the [documentation](https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/introduction#shops).
+  - For more information, please refer to the [documentation](https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/configuration#shops).
   - **NOTE:** These changes might impact your environment variables used for deployments. Please check your infrastructure and deployment setup and adapt accordingly!
   - _Previous Store Configuration in `nuxt.config.ts`:_
 

package/README.md

@@ -36,7 +36,7 @@ npm install --save-dev @scayle/storefront-nuxt
 
 ## Getting Started
 
-Visit the [Quickstart Guide](https://scayle.dev/en/storefront-guide/developer-guide/getting-started/setup-your-storefront) to get started with Storefront Nuxt.
+Visit the [Quickstart Guide](https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/readme/setup-your-storefront) to get started with Storefront Nuxt.
 
 Visit the [Docs](https://scayle.dev) to learn more about our system requirements.
 
@@ -45,7 +45,7 @@ Visit the [Docs](https://scayle.dev) to learn more about our system requirements
 [SCAYLE](https://scayle.com) is a full-featured e-commerce software solution that comes with flexible APIs.
 Within SCAYLE, you can manage all aspects of your shop, such as products, stocks, customers, and transactions.
 
-Learn more about [SCAYLE’s architecture](https://scayle.dev/en/developer-guide) and commerce modules in the docs.
+Learn more about [SCAYLE’s architecture](https://scayle.dev/en/core-documentation/welcome-to-scayle/getting-started) and commerce modules in the docs.
 
 ## Other channels
 

package/dist/module.d.mts

@@ -1,6 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { HookResult } from '@nuxt/schema';
-import { ModuleBaseOptions } from '../dist/runtime/types/module.js';
 export * from '../dist/runtime/types/module.js';
 
 /**
@@ -52,7 +51,17 @@ declare module '@nuxt/schema' {
  *
  * @returns The Nuxt module.
  */
-declare const _default: _nuxt_schema.NuxtModule<ModuleBaseOptions, ModuleBaseOptions, false>;
+declare const _default: _nuxt_schema.NuxtModule<{
+    rpcDir?: string | undefined;
+    rpcMethodNames?: string[] | undefined;
+    rpcMethodOverrides?: ("getProductById" | "getProductsByIds" | "getProductsByReferenceKeys" | "getProductsCount" | "fetchAllFiltersForCategory" | "getFilters" | "getProductsByCategory" | "oauthForgetPassword" | "oauthGuestLogin" | "oauthLogin" | "oauthRegister" | "oauthRevokeToken" | "refreshAccessToken" | "updatePasswordByHash" | "addItemToBasket" | "addItemsToBasket" | "getBasket" | "removeItemFromBasket" | "clearBasket" | "mergeBaskets" | "updateBasketItem" | "getApplicablePromotionsByCode" | "updatePromotions" | "getBrands" | "getBrandById" | "getRootCategories" | "getCategoryByPath" | "getCategoriesByPath" | "getCategoryById" | "getCategoryTree" | "getCampaign" | "getCampaignKey" | "getOrderDataByCbd" | "getSearchSuggestions" | "resolveSearch" | "getShopConfiguration" | "getUser" | "fetchUser" | "refreshUser" | "getAccessToken" | "getWishlist" | "addItemToWishlist" | "removeItemFromWishlist" | "clearWishlist" | "getOrderById" | "getShopUserAddresses" | "updateShopUser" | "updatePassword" | "getCheckoutToken" | "getVariantById" | "fetchAllNavigationTrees" | "fetchNavigationTreeById" | "fetchNavigationTreeByName" | "getPromotions" | "getCurrentPromotions" | "getPromotionsByIds" | "getExternalIdpRedirect" | "handleIDPLoginCallback")[] | undefined;
+    apiBasePath?: string | undefined;
+}, {
+    rpcDir?: string | undefined;
+    rpcMethodNames?: string[] | undefined;
+    rpcMethodOverrides?: ("getProductById" | "getProductsByIds" | "getProductsByReferenceKeys" | "getProductsCount" | "fetchAllFiltersForCategory" | "getFilters" | "getProductsByCategory" | "oauthForgetPassword" | "oauthGuestLogin" | "oauthLogin" | "oauthRegister" | "oauthRevokeToken" | "refreshAccessToken" | "updatePasswordByHash" | "addItemToBasket" | "addItemsToBasket" | "getBasket" | "removeItemFromBasket" | "clearBasket" | "mergeBaskets" | "updateBasketItem" | "getApplicablePromotionsByCode" | "updatePromotions" | "getBrands" | "getBrandById" | "getRootCategories" | "getCategoryByPath" | "getCategoriesByPath" | "getCategoryById" | "getCategoryTree" | "getCampaign" | "getCampaignKey" | "getOrderDataByCbd" | "getSearchSuggestions" | "resolveSearch" | "getShopConfiguration" | "getUser" | "fetchUser" | "refreshUser" | "getAccessToken" | "getWishlist" | "addItemToWishlist" | "removeItemFromWishlist" | "clearWishlist" | "getOrderById" | "getShopUserAddresses" | "updateShopUser" | "updatePassword" | "getCheckoutToken" | "getVariantById" | "fetchAllNavigationTrees" | "fetchNavigationTreeById" | "fetchNavigationTreeByName" | "getPromotions" | "getCurrentPromotions" | "getPromotionsByIds" | "getExternalIdpRedirect" | "handleIDPLoginCallback")[] | undefined;
+    apiBasePath?: string | undefined;
+}, false>;
 
 export { _default as default };
 export type { ModuleHooks };

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "8.44.2",
+  "version": "8.45.1",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -1,5 +1,5 @@
 import { existsSync } from 'node:fs';
-import { defineNuxtModule, createResolver, extendViteConfig, addTypeTemplate, addPlugin, addImportsDir } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, addServerTemplate, addTypeTemplate, extendViteConfig, addPlugin, addImportsDir } from '@nuxt/kit';
 import { rpcMethods } from '@scayle/storefront-core';
 import { defu } from 'defu';
 import { genExport, genImport, genSafeVariableName } from 'knitwork';
@@ -54,7 +54,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.44.2";
+const PACKAGE_VERSION = "8.45.1";
 const logger = createConsola({
   fancy: true,
   formatOptions: {
@@ -228,49 +228,73 @@ const module = defineNuxtModule({
   },
   // Default configuration options of the Nuxt module
   defaults: {
-    // TODO: Nuxt is making us give a default for each options
-    // How do we mark some as required?
-    session: {
-      cookieName: "$session",
-      sameSite: "lax"
-      // TODO: If we give a default value here, nuxt will generate the runtime type incorrectly
-      // secret needs to be typed as string | string[]
-      // secret: 'current-secret',
-      // if we set maxAge explicitly to undefined `useRuntimeConfig` will set it default to '' which leads to no sessions not being saved
-      // maxAge: undefined,
-    },
-    shopSelector: "domain",
-    oauth: {
-      apiHost: "",
-      clientId: "",
-      clientSecret: ""
-    },
-    idp: {
-      enabled: false,
-      idpKeys: [],
-      idpRedirectURL: ""
-    },
-    appKeys: {
-      wishlistKey: "wishlist_{shopId}_{userId}",
-      basketKey: "basket_{shopId}_{userId}",
-      hashAlgorithm: "sha256"
-    },
-    legacy: {
-      enableSessionMigration: false
-    },
-    /**
-     * The internal access header.
-     *
-     * @hidden
-     */
-    internalAccessHeader: ""
+    rpcDir: void 0,
+    rpcMethodNames: void 0,
+    rpcMethodOverrides: void 0,
+    apiBasePath: "/api"
   },
   async setup(options, nuxt) {
     const { resolve } = createResolver(import.meta.url);
     const { resolve: appResolve } = createResolver(nuxt.options.rootDir);
+    addServerTemplate({
+      filename: "#internal/storefront-options.mjs",
+      getContents: () => `
+        export const apiBasePath = '${options.apiBasePath}'
+        export const rpcMethodNames = ${options.rpcMethodNames ? JSON.stringify(options.rpcMethodNames, null, 2) : "undefined"}
+        export const rpcMethodOverrides = ${options.rpcMethodOverrides ? JSON.stringify(options.rpcMethodOverrides, null, 2) : "undefined"}
+      `
+    });
+    addTypeTemplate({
+      filename: "types/storefront-options.d.ts",
+      getContents: () => `
+        declare module '#internal/storefront-options.mjs' {
+          export const apiBasePath: string
+          export const rpcMethodNames: string[] | undefined
+          export const rpcMethodOverrides: string[] | undefined
+        }
+      `
+    });
+    const runtimeConfigDefaults = {
+      // TODO: Nuxt is making us give a default for each options
+      // How do we mark some as required?
+      session: {
+        cookieName: "$session",
+        sameSite: "lax"
+        // TODO: If we give a default value here, nuxt will generate the runtime type incorrectly
+        // secret needs to be typed as string | string[]
+        // secret: 'current-secret',
+        // if we set maxAge explicitly to undefined `useRuntimeConfig` will set it default to '' which leads to no sessions not being saved
+        // maxAge: undefined,
+      },
+      shopSelector: "domain",
+      oauth: {
+        apiHost: "",
+        clientId: "",
+        clientSecret: ""
+      },
+      idp: {
+        enabled: false,
+        idpKeys: [],
+        idpRedirectURL: ""
+      },
+      appKeys: {
+        wishlistKey: "wishlist_{shopId}_{userId}",
+        basketKey: "basket_{shopId}_{userId}",
+        hashAlgorithm: "sha256"
+      },
+      legacy: {
+        enableSessionMigration: false
+      },
+      internalAccessHeader: "",
+      shops: {},
+      sapi: {
+        host: "",
+        token: ""
+      }
+    };
     nuxt.options.runtimeConfig.storefront = defu(
       nuxt.options.runtimeConfig.storefront,
-      options
+      runtimeConfigDefaults
     );
     nuxt.options.runtimeConfig.public.storefront = defu(nuxt.options.runtimeConfig.public.storefront, {
       log: {

package/dist/runtime/campaignKey.d.ts

@@ -6,7 +6,7 @@ import type { StorefrontAPIClient, CachedType, Log } from '@scayle/storefront-co
  * sorts them, and returns the key of the first active one.
  * The retrieved campaigns are cached for a specified duration.
  *
- * @see https://scayle.dev/en/user-guide/shops/promotions/discounts-and-offers/price-campaigns
+ * @see https://scayle.dev/en/core-documentation/checkout-guide/features/promotions/discounts-and-offers/price-campaigns
  * @see https://scayle.dev/en/api-guides/storefront-api/resources/campaigns/list-campaigns
  *
  * @param sapiClient The Storefront API client.

package/dist/runtime/composables/core/useIDP.d.ts

@@ -10,7 +10,7 @@ type UseIDPBaseReturn = Pick<Awaited<UseRpcReturn<'getExternalIdpRedirect'>>, 'd
  *
  * This composables uses the `useRpc` composable to call the `getExternalIdpRedirect` RPC method.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/authentication#redirect-url
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/sessions#idp-redirect-url
  *
  * @param params The parameters for the `getExternalIdpRedirect` RPC call.
  * @param key A unique key for the RPC call. Used for caching and invalidation. Defaults to 'useIDP'.

package/dist/runtime/composables/core/useRpc.d.ts

@@ -62,7 +62,7 @@ export type ExtendedAsyncData<ResT, ErrorT = unknown, DataT = ResT, PickKeys ext
  * disabled globally via the `disableDefaultGetCachedDataOverride` option in the public runtime config, or individually per call using the `options` parameter.
  *
  * @see https://nuxt.com/docs/api/composables/use-async-data#params
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/rpc-methods#userpc
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/rpc-methods#userpc
  *
  * @param method The name of the RPC method to call (e.g., 'useBrand).
  * @param key A unique key for caching, persisting the data between server and client,

package/dist/runtime/composables/core/useSession.d.ts

@@ -3,8 +3,8 @@
  *
  * This composable leverages `useRpcCall` to interact with corresponding RPC methods.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/sessions
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/authentication
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/sessions
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/features/login-and-registration
  *
  * @returns An object containing functions for various session management operations.
  */

package/dist/runtime/composables/storefront/useCurrentPromotions.d.ts

@@ -11,7 +11,7 @@ import type { MaybeRefOrGetter } from 'vue';
  * or from async data otherwise.
  *
  * @see https://scayle.dev/en/api-guides/storefront-api/resources/promotions/list-promotions
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/rpc-methods#managing-shared-state-with-userpc
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/data-and-state#shared-state-and-caching
  *
  * @template DataT The type of the normalized RPC response data. Defaults to `NormalizedRpcResponse<'getCurrentPromotions'>`.
  * @template PickKeys The keys to pick from the data. Defaults to all keys of `DataT`.

package/dist/runtime/composables/storefront/useWishlist.d.ts

@@ -57,7 +57,7 @@ type UseWishlistBaseReturn = Awaited<UseRpcReturn<'getWishlist'>> & {
  * requiring a type assertion to `WishlistResponseData`.
  *
  * @see https://scayle.dev/en/api-guides/storefront-api/resources/wishlists/get-a-wishlist
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/rpc-methods#managing-shared-state-with-userpc
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/data-and-state#shared-state-and-caching
  *
  * @param params An object containing parameters and options for all wishlist-related RPC calls.
  * @param params.params The parameters for the `useWishlist` RPC method.

package/dist/runtime/context.d.ts

@@ -3,14 +3,15 @@ import type { RuntimeConfig } from '@nuxt/schema';
 import type { H3Event } from 'h3';
 import type { Log, RpcContext, Cache as CacheInterface } from '@scayle/storefront-core';
 import { StorefrontAPIClient } from '@scayle/storefront-core';
-import type { ShopConfig, StorefrontConfig } from '../module.js';
+import type { ShopConfig } from '../module.js';
+import type { StorefrontRuntimeConfigType } from './utils/zodSchema.js';
 /**
  * Interface defining the options for the context builder.
  */
 export interface ContextBuilderOptions {
     $cache: CacheInterface;
     $shopConfig: ShopConfig;
-    $storefront: StorefrontConfig;
+    $storefront: StorefrontRuntimeConfigType;
     $log: Log;
     sessionId?: string;
     session?: Session;
@@ -26,7 +27,7 @@ export interface ContextBuilderOptions {
  * It also sets up getters for IP, headers, user, access tokens,
  * and functions for session management and user updates.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/rpc-methods#rpc-context
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/rpc-methods#rpc-context
  *
  * @param context The context builder options.
  * @param context.$cache The cache instance.

package/dist/runtime/context.js

@@ -10,6 +10,7 @@ import { useNitroApp } from "nitropack/runtime";
 import { getCachedFunction } from "./cached.js";
 import { getApiBasePath } from "./server/middleware/bootstrap-utils.js";
 import { fetchCampaignKey } from "./campaignKey.js";
+import * as moduleOptions from "#internal/storefront-options.mjs";
 async function getWishlistKey(appKeys, session, $log, $shopConfig) {
   return session.data.user ? await generateWishlistKey({
     keyTemplate: appKeys.wishlistKey,
@@ -69,7 +70,7 @@ export const buildContext = async (context) => {
   const callRpc = buildRpcCall(
     context.event,
     $shopConfig,
-    getApiBasePath($storefront, "/")
+    getApiBasePath(moduleOptions, "/")
   );
   const rpcContext = {
     cached,

package/dist/runtime/server/middleware/bootstrap-utils.d.ts

@@ -1,6 +1,7 @@
 import type { H3Event } from 'h3';
-import type { ModuleBaseOptions, PublicShopConfig, ShopConfig, ShopConfigIndexed } from '../../../module.js';
+import type { ModuleOptions, PublicShopConfig, ShopConfig, ShopConfigIndexed } from '../../../module.js';
 import type { NitroRuntimeConfigApp } from 'nitropack';
+import type { StorefrontRuntimeConfigType } from '../../utils/zodSchema.js';
 /**
  * Represents the bootstrapped path information.
  */
@@ -39,7 +40,7 @@ export declare const getShopByPath: (event: H3Event, shops: ShopConfig[], appBas
  *
  * @returns The shops as an array.
  */
-export declare const convertShopsToList: (shops: ShopConfig[] | ShopConfigIndexed) => ShopConfig[];
+export declare const convertShopsToList: (shops: ShopConfig[] | ShopConfigIndexed | StorefrontRuntimeConfigType["shops"]) => ShopConfig[];
 /**
  * Gets the API base path.
  *
@@ -48,7 +49,7 @@ export declare const convertShopsToList: (shops: ShopConfig[] | ShopConfigIndexe
  *
  * @returns The API base path.
  */
-export declare function getApiBasePath(storefrontConfig: Pick<ModuleBaseOptions, 'apiBasePath'>, baseUrl: string): string;
+export declare function getApiBasePath(storefrontConfig: Pick<ModuleOptions, 'apiBasePath'>, baseUrl: string): string;
 /**
  * Retrieves the current shop configuration for a given request.
  *
@@ -58,7 +59,7 @@ export declare function getApiBasePath(storefrontConfig: Pick<ModuleBaseOptions,
  *
  * @returns The shop config for the current request if found or undefined.
  */
-export declare function getCurrentShopConfigForRequest(event: H3Event, storefrontConfig: Pick<ModuleBaseOptions, 'shops' | 'shopSelector'>, runtimeConfig: NitroRuntimeConfigApp): ShopConfig | undefined;
+export declare function getCurrentShopConfigForRequest(event: H3Event, storefrontConfig: Pick<StorefrontRuntimeConfigType, 'shops' | 'shopSelector'>, runtimeConfig: NitroRuntimeConfigApp): ShopConfig | undefined;
 /**
  * Transforms shop configuration data into a public representation, including active status.
  *

package/dist/runtime/server/middleware/bootstrap.js

@@ -15,6 +15,7 @@ import {
 } from "./bootstrap-utils.js";
 import { useRedirects } from "./redirects.js";
 import { useRuntimeConfig } from "#imports";
+import * as moduleOptions from "#internal/storefront-options.mjs";
 const generateSessionId = (event) => {
   let userId;
   if (event?.context.session?.data?.accessToken) {
@@ -147,7 +148,7 @@ export default defineEventHandler(async (event) => {
     return;
   }
   const $storefrontConfig = config.storefront;
-  if (path === `${$storefrontConfig.apiBasePath ?? "/api"}/up`) {
+  if (path === `${getApiBasePath(moduleOptions, "/")}/up`) {
     return;
   }
   const $shopConfig = getCurrentShopConfigForRequest(
@@ -163,7 +164,7 @@ export default defineEventHandler(async (event) => {
     return;
   }
   const apiBasePath = getApiBasePath(
-    $storefrontConfig,
+    moduleOptions,
     config.app.baseURL
   );
   if (!event.context.$rpcContext) {

package/dist/runtime/server/middleware/redirects.d.ts

@@ -7,8 +7,8 @@ import type { H3Event } from 'h3';
  * It utilizes a cache to store redirect results and falls back to the
  * Storefront API if no cached redirect is available.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/redirects#overview
- * @see https://scayle.dev/en/user-guide/shops/storefront/redirects
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/features/redirects#overview
+ * @see https://scayle.dev/en/core-documentation/the-basics/shops/redirects
  *
  * @param event The H3 event object.
  */