@scayle/storefront-core 8.44.2 → 8.45.1

package/CHANGELOG-V7.md

@@ -25,7 +25,7 @@ This changelog contains all changes of `@scayle/storefront-core` above v6.0.0 an
 - Extend `FetchProductsByCategoryParams` type to support `trackSearchAnalyticsEvent?: boolean`
 - Allow passing of the `trackSearchAnalyticsEvent` parameter into the `getProductsByCategory` RPC method.
   **NOTE**: To prevent logging the search term on every page request when when paginating with the `page` parameter, the `trackSearchAnalyticsEvent` parameter is only passed on the first page (`page === 1`).
-  For more details on how to utilize this, check the [SCAYLE Search Analytics section](https://scayle.dev/en/developer-guide/products/search#scayle-search-analytics) in the SCAYLE Resource Center.
+  For more details on how to utilize this, check the [SCAYLE Search Analytics section](https://scayle.dev/en/core-documentation/the-basics/shops/search#scayle-search-analytics) in the SCAYLE Resource Center.
 
 ## 7.69.0
 

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @scayle/storefront-core
 
+## 8.45.1
+
+### Patch Changes
+
+- Updated SCAYLE Resource Center references
+
+**Dependencies**
+
+- Updated dependency to @scayle/unstorage-scayle-kv-driver@2.0.6
+- Updated dependency to @scayle/storefront-api@18.16.1
+
+## 8.45.0
+
 ## 8.44.2
 
 ### Patch Changes
@@ -888,7 +901,7 @@ async function rpcMethod(context) {
 ```
 
 To override the default campaign key, override the getCampaignKey RPC with your own implementation.
-See [Overriding core RPC Methods](https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/rpc-methods#overriding-core-rpc-methods) for more.
+See [Overriding core RPC Methods](https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/rpc-methods#overriding-core-rpc-methods) for more.
 
 ## 8.7.1
 

package/README.md

@@ -35,7 +35,7 @@ npm install @scayle/storefront-core
 
 ## Getting Started
 
-Visit the [Quickstart Guide](https://scayle.dev/en/storefront-guide/developer-guide/getting-started/setup-your-storefront) to get started with Storefront Core.
+Visit the [Quickstart Guide](https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/readme/setup-your-storefront) to get started with Storefront Core.
 
 Visit the [Docs](https://scayle.dev) to learn more about our system requirements.
 
@@ -44,7 +44,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/api/customer.d.ts

@@ -46,7 +46,7 @@ interface PasswordUpdate {
  *
  * Should be initialized with the token set acquired from the Auth API.
  *
- * @see https://scayle.dev/en/api-guides/customer-account-api
+ * @see https://scayle.dev/en/api-guides/customer-account-api/
  */
 export declare class CustomerAPIClient {
     /**

package/dist/api/oauth.d.ts

@@ -29,7 +29,7 @@ export declare function getOAuthClient(context: RpcContext): OAuthClient;
 /**
  * A client for interacting with the Checkout Authentication API
  *
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api
+ * @see https://scayle.dev/en/api-guides/authentication-api/
  */
 export declare class OAuthClient {
     /**
@@ -64,7 +64,7 @@ export declare class OAuthClient {
      *
      * @returns The OAuth response containing access and refresh tokens.
      *
-     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/create-new-user
+     * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/create-new-user
      */
     register(payload: RegisterRequest): Promise<Oauth>;
     /**
@@ -74,7 +74,7 @@ export declare class OAuthClient {
      *
      * @returns The OAuth response containing access and refresh tokens.
      *
-     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users
+     * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/log-in-users
      */
     login(payload: LoginRequest): Promise<Oauth>;
     /**
@@ -84,7 +84,7 @@ export declare class OAuthClient {
      *
      * @returns The OAuth response containing access and refresh tokens.
      *
-     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users-as-guest
+     * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/log-in-users-as-guest
      */
     guestLogin(payload: GuestRequest): Promise<Oauth>;
     /**
@@ -94,7 +94,7 @@ export declare class OAuthClient {
      *
      * @returns Nothing (resolves when the request completes successfully).
      *
-     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/send-password-reset-email
+     * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/send-password-reset-email
      */
     sendPasswordResetEmail(payload: SendResetPasswordEmailRequest): Promise<void>;
     /**
@@ -105,7 +105,7 @@ export declare class OAuthClient {
      *
      * @returns The new OAuth response with updated tokens.
      *
-     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/update-password-by-hash
+     * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/update-password-by-hash
      */
     updatePasswordByHash(payload: UpdatePasswordByHashRequest): Promise<Oauth>;
     /**
@@ -131,7 +131,7 @@ export declare class OAuthClient {
      *
      * @returns Nothing (resolves if the token is valid, rejects otherwise).
      *
-     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/validate-present-token
+     * @see https://scayle.dev/en/api-guides/authentication-api/resources/bearer-auth/validate-present-token
      */
     validateToken(accessToken: string): Promise<void>;
     /**
@@ -149,7 +149,7 @@ export declare class OAuthClient {
      * @param accessToken The access token to use for authorization.
      * @returns Nothing (resolves when the token is successfully revoked).
      *
-     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/delete-access-token-with-id
+     * @see https://scayle.dev/en/api-guides/authentication-api/resources/bearer-auth/delete-access-token-with-id
      */
     revokeToken(shopId: number, accessToken: string): Promise<void>;
     /**

package/dist/api/oauth.mjs

@@ -121,7 +121,7 @@ export class OAuthClient {
    *
    * @returns The OAuth response containing access and refresh tokens.
    *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/create-new-user
+   * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/create-new-user
    */
   async register(payload) {
     this.logger?.debug("Registering user");
@@ -138,7 +138,7 @@ export class OAuthClient {
    *
    * @returns The OAuth response containing access and refresh tokens.
    *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users
+   * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/log-in-users
    */
   async login(payload) {
     this.logger?.debug("Logging in");
@@ -155,7 +155,7 @@ export class OAuthClient {
    *
    * @returns The OAuth response containing access and refresh tokens.
    *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users-as-guest
+   * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/log-in-users-as-guest
    */
   async guestLogin(payload) {
     this.logger?.debug("Logging in as guest");
@@ -172,7 +172,7 @@ export class OAuthClient {
    *
    * @returns Nothing (resolves when the request completes successfully).
    *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/send-password-reset-email
+   * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/send-password-reset-email
    */
   async sendPasswordResetEmail(payload) {
     this.logger?.debug("Sending password reset email");
@@ -190,7 +190,7 @@ export class OAuthClient {
    *
    * @returns The new OAuth response with updated tokens.
    *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/update-password-by-hash
+   * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/update-password-by-hash
    */
   async updatePasswordByHash(payload) {
     this.logger?.debug("Updating password by hash");
@@ -240,7 +240,7 @@ export class OAuthClient {
    *
    * @returns Nothing (resolves if the token is valid, rejects otherwise).
    *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/validate-present-token
+   * @see https://scayle.dev/en/api-guides/authentication-api/resources/bearer-auth/validate-present-token
    */
   async validateToken(accessToken) {
     this.logger?.debug("Validating access token");
@@ -266,7 +266,7 @@ export class OAuthClient {
    * @param accessToken The access token to use for authorization.
    * @returns Nothing (resolves when the token is successfully revoked).
    *
-   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/delete-access-token-with-id
+   * @see https://scayle.dev/en/api-guides/authentication-api/resources/bearer-auth/delete-access-token-with-id
    */
   async revokeToken(shopId, accessToken) {
     this.logger?.debug("Revoking access token");

package/dist/rpc/methods/checkout/checkout.mjs

@@ -33,7 +33,7 @@ export const getCheckoutToken = defineRpcHandler(async (jwtPayload = {}, context
     carrier,
     basketId: context.basketKey,
     campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.44.2"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.45.1"}`).setProtectedHeader({ alg: "HS256", typ: "JWT" }).sign(secret);
   return {
     accessToken: refreshedAccessToken,
     checkoutJwt

package/dist/rpc/methods/oauth/idp.d.ts

@@ -2,7 +2,7 @@ import type { RpcHandler } from '../../../types';
 /**
  * Retrieves external IDP redirect URLs.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/authentication#overview
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/features/login-and-registration#overview
  *
  * @param params The parameters for retrieving the external IDP redirect.
  * @param params.queryParams Optional query parameters to include in the redirect URLs.
@@ -20,7 +20,7 @@ export declare const getExternalIdpRedirect: RpcHandler<{
 /**
  * Handles the IDP login callback.
  *
- * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/authentication#overview
+ * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/features/login-and-registration#overview
  *
  * @param payload The payload containing the authorization code.
  * @param payload.code The authorization code.

package/dist/rpc/methods/products.mjs

@@ -291,7 +291,7 @@ export const getProductsByCategory = async function getProductsByCategory2(param
     // The consuming project should not include trackSearchAnalyticsEvent parameter when paginating through
     // results with the page parameter, as this logs the search term on every page request.
     // Instead, log the term only once, when the search is first performed.
-    // https://scayle.dev/en/developer-guide/products/search#scayle-search-analytics
+    // https://scayle.dev/en/core-documentation/the-basics/shops/search#scayle-search-analytics
     trackSearchAnalyticsEvent
   });
   return {

package/dist/types/api/auth.d.ts

@@ -3,7 +3,7 @@ import type { Gender } from '../user';
  * Represents a pair of OAuth 2.0 access and refresh tokens.  These tokens are used for authentication and authorization within an OAuth 2.0 flow.
  *
  * @see https://datatracker.ietf.org/doc/html/rfc6749#section-1.4
- * @see https://scayle.dev/en/checkout-guide/authentication-accounts/token-based-authentication
+ * @see https://scayle.dev/en/core-documentation/checkout-guide/authentication-accounts/authetication/token-management#token-types
  */
 export interface OAuthTokens {
     accessToken: string;
@@ -21,7 +21,7 @@ interface BaseError {
  * Represents a Bad Request (400) error indicating a validation failure, often caused by incorrect client input.
  *
  * @see https://datatracker.ietf.org/doc/html/rfc6750#section-3.1
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/getting-started/errors#_400s-status-codes
+ * @see https://scayle.dev/en/api-guides/authentication-api/getting-started/errors#_400s-status-codes
  */
 export interface BadRequestError extends BaseError {
     error: 'validation_error';
@@ -35,7 +35,7 @@ export interface BadRequestError extends BaseError {
  * Represents an Unauthorized (401) error indicating client authentication failure, typically due to invalid credentials.
  *
  * @see https://datatracker.ietf.org/doc/html/rfc6750#section-3.1
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/getting-started/errors#unauthorized-client
+ * @see https://scayle.dev/en/api-guides/authentication-api/getting-started/errors#unauthorized-client
  */
 export interface UnauthorizedError extends BaseError {
     error: 'INVALID_CLIENT';
@@ -45,7 +45,7 @@ export interface UnauthorizedError extends BaseError {
 /**
  * Represents the request body for login.
  *
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users
+ * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/log-in-users
  */
 export interface LoginRequest {
     email: string;
@@ -55,7 +55,7 @@ export interface LoginRequest {
 /**
  * Represents the request body for registration.
  *
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/create-new-user
+ * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/create-new-user
  */
 export interface RegisterRequest {
     first_name: string;
@@ -68,7 +68,7 @@ export interface RegisterRequest {
 /**
  * Represents the request body for guest checkout.
  *
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users-as-guest
+ * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/log-in-users-as-guest
  */
 export interface GuestRequest {
     first_name: string;
@@ -80,7 +80,7 @@ export interface GuestRequest {
 /**
  * Represents the request body for sending a password reset email.
  *
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/send-password-reset-email
+ * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/send-password-reset-email
  */
 export interface SendResetPasswordEmailRequest {
     email: string;
@@ -90,7 +90,7 @@ export interface SendResetPasswordEmailRequest {
 /**
  * Represents the request body for updating a password using a hash.
  *
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/update-password-by-hash
+ * @see https://scayle.dev/en/api-guides/authentication-api/resources/oauth-client/update-password-by-hash
  */
 export interface UpdatePasswordByHashRequest {
     password: string;
@@ -100,7 +100,7 @@ export interface UpdatePasswordByHashRequest {
 /**
  * Represents the request body for updating a password.
  *
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/update-customers-password
+ * @see https://scayle.dev/en/api-guides/authentication-api/resources/bearer-auth/update-customers-password
  */
 export interface UpdatePasswordRequest {
     password: string;
@@ -119,7 +119,6 @@ export interface RefreshTokenRequest {
  * Represents a standard OAuth 2.0 access token response as defined in RFC 6750.
  *
  * @see https://datatracker.ietf.org/doc/html/rfc6750
- * @see https://scayle.dev/en/api-guides/checkout-authentication-api/getting-started/authentication#auth-response
  */
 export interface Oauth {
     /** The type of token. A `Bearer` token indicates that anyone who possesses the token can use it to access the protected resources, without further authentication. */

package/dist/types/api/context.d.ts

@@ -142,7 +142,7 @@ export type RpcContext = {
      * ```
      *
      * To override the default campaign key, override the getCampaignKey RPC with your own implementation
-     * @see https://scayle.dev/en/storefront-guide/developer-guide/basic-setup/rpc-methods#overriding-core-rpc-methods
+     * @see https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/technical-foundation/rpc-methods#overriding-core-rpc-methods
      */
     campaignKey?: string;
     destroySessionsForUserId: (userId: number, sessionsToKeep?: string[]) => Promise<void>;

package/dist/types/sapi/product.d.ts

@@ -21,7 +21,7 @@ export type VariantId = number;
  * a `FieldSet` might represent "cotton" with fields like
  * `"material name"`: `"cotton"`, `"percentage"`: `70`.
  *
- * @see https://scayle.dev/en/user-guide/settings/product-structure/attribute-groups#advanced-attribute-groups
+ * @see https://scayle.dev/en/core-documentation/the-basics/products/attribute-groups#advanced-attribute-groups
  */
 export type FieldSet = Array<Array<{
     [key: string]: string | number | null | undefined;
@@ -37,7 +37,7 @@ export type FieldSet = Array<Array<{
  *  - Simple: `"material: 70% cotton, 30% polyester"`
  *  - Complex: `"inner material: 100% polyester, upper material: 70% cotton, 30% polyester"`
  *
- * @see https://scayle.dev/en/user-guide/settings/product-structure/attribute-groups#advanced-attribute-groups
+ * @see https://scayle.dev/en/core-documentation/the-basics/products/attribute-groups#advanced-attribute-groups
  */
 export declare type GroupSet = Array<{
     fieldSet: FieldSet;
@@ -115,7 +115,7 @@ export type FetchProductsByCategoryParams = {
     /**
      * Whether to track search analytics event.
      *
-     * @see https://scayle.dev/en/developer-guide/products/search#search-analytics-and-tracking
+     * @see https://scayle.dev/en/core-documentation/the-basics/shops/search#search-analytics-and-tracking
      */
     trackSearchAnalyticsEvent?: boolean;
 } & ({

package/dist/types/sapi/productFilter.d.ts

@@ -11,7 +11,7 @@ export type ProductFilterValues = ProductFilter['values'];
  * Represents a single value of a product filter. This can be a value of an attribute filter,
  * a boolean value indicating a filter state (e.g., sale: true/false), or a value of an identifier filter.
  *
- * @see https://scayle.dev/en/developer-guide/products/product-filters#get-filter-values
+ * @see https://scayle.dev/en/core-documentation/the-basics/shops/filters#get-filter-values
  */
 export type ProductFilterValue = AttributesFilterValue | {
     /**  The boolean value of the filter, e.g. for a "sale" filter. */

package/dist/utils/campaign.d.ts

@@ -4,7 +4,7 @@ import type { Campaign } from '@scayle/storefront-api';
  *
  * Determines if the current time falls within the campaign's start and end dates.
  *
- * @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
  *
  * @param campaign The campaign to check.
  *
@@ -16,7 +16,7 @@ export declare const isCampaignActive: (campaign?: Campaign) => boolean;
  *
  * Compares the campaign's end date with the current time.
  *
- * @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
  *
  * @param campaign The campaign to check.
  *
@@ -28,7 +28,7 @@ export declare const campaignHasNotEnded: (campaign: Campaign) => boolean;
  *
  * Uses the difference between start times to determine order.
  *
- * @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
  *
  * @param a The first campaign to compare.
  * @param b The second campaign to compare.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.44.2",
+  "version": "8.45.1",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -11,7 +11,7 @@
   "repository": {
     "url": "git+https://github.com/scayle/storefront-core.git"
   },
-  "website": "https://scayle.dev/en/storefront-guide/developer-guide/getting-started/about-storefront",
+  "website": "https://scayle.dev/en/core-documentation/storefront-guide/storefront-application/readme/what-is-storefront",
   "sideEffects": false,
   "exports": {
     ".": {
@@ -48,12 +48,12 @@
     "ufo": "^1.5.3",
     "uncrypto": "^0.1.3",
     "utility-types": "^3.11.0",
-    "@scayle/storefront-api": "18.16.0",
-    "@scayle/unstorage-scayle-kv-driver": "2.0.5"
+    "@scayle/storefront-api": "18.16.1",
+    "@scayle/unstorage-scayle-kv-driver": "2.0.6"
   },
   "devDependencies": {
     "@types/crypto-js": "4.2.2",
-    "@types/node": "22.18.10",
+    "@types/node": "22.18.11",
     "@types/webpack-env": "1.18.8",
     "@vitest/coverage-v8": "3.2.4",
     "dprint": "0.50.2",