@scayle/storefront-core 8.3.2 → 8.4.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @scayle/storefront-core
 
+## 8.4.0
+
+### Minor Changes
+
+- [Types] - Extend `Gender` type with `n` option
+
 ## 8.3.2
 
 ### Patch Changes

package/dist/api/customer.cjs

@@ -61,7 +61,9 @@ class CustomerAPIClient {
     throw new _fetch.FetchError(response);
   }
   /**
-   * Get the addresses for the current customer
+   * Get the addresses for the current customer.
+   *
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/address/list-addresses
    */
   async getAddresses(shopId) {
     return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/addresses`, {
@@ -73,8 +75,9 @@ class CustomerAPIClient {
   }
   /**
    * Returns customer data and latest orders.
-   * When not logged in will return undefined.
-   * @see https://scayle.dev/api/oauth/latest/fetch-authorized-payload
+   * When not logged in, it will return `undefined`.
+   *
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/get-customer
    */
   async getMe(shopId, accessToken) {
     return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/me`, {
@@ -88,8 +91,9 @@ class CustomerAPIClient {
     }));
   }
   /**
-   * Fetch a customer's order
-   * @see https://scayle.dev/api/oauth/latest/fetch-order-by-id
+   * Retrieve a customer's order.
+   *
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/order/get-order
    */
   async getOrder(shopId, orderId) {
     return this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/order/${orderId}`, {
@@ -100,9 +104,9 @@ class CustomerAPIClient {
     }));
   }
   /**
-   * Update the customer's contact details
+   * Update contact details of a customer.
    *
-   * @see https://scayle.dev/api/oauth/latest/put-customer-contact
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-contact-details
    */
   async updateContactInfo(shopId, {
     email,
@@ -121,7 +125,9 @@ class CustomerAPIClient {
     }));
   }
   /**
-   * Update the customer's personal details
+   * Update customer personal data.
+   *
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-personal-data
    */
   async updatePersonalInfo(shopId, payload) {
     return await this.sendRequest(() => fetch(`${this.baseURL}/api/oauth/customer/personal`, {
@@ -134,9 +140,9 @@ class CustomerAPIClient {
     }));
   }
   /**
-   * Update the customer's password
+   * Update customer password.
    *
-   * @see https://scayle.dev/api/oauth/latest/put-customer-password
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-password
    */
   async updatePassword(shopId, {
     password,

package/dist/api/customer.d.ts

@@ -28,11 +28,11 @@ interface PasswordUpdate {
     newPassword: string;
 }
 /**
- * An API client for interacting with the Checkout Customer API
+ * An API client for interacting with the Checkout Customer API.
  *
- * Should be initialized with the token set acquired from the Auth API
+ * Should be initialized with the token set acquired from the Auth API.
  *
- * @see https://scayle.dev/api/oauth/latest
+ * @see https://scayle.dev/en/api-guides/customer-account-api
  */
 export declare class CustomerAPIClient {
     baseURL: string;
@@ -42,34 +42,40 @@ export declare class CustomerAPIClient {
     get headers(): HeadersInit;
     sendRequest<BodyType>(request: () => Promise<Response>, retry?: boolean): Promise<BodyType>;
     /**
-     * Get the addresses for the current customer
+     * Get the addresses for the current customer.
+     *
+     * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/address/list-addresses
      */
     getAddresses(shopId: number): Promise<PaginatedResponse<ShopUserAddress>>;
     /**
      * Returns customer data and latest orders.
-     * When not logged in will return undefined.
-     * @see https://scayle.dev/api/oauth/latest/fetch-authorized-payload
+     * When not logged in, it will return `undefined`.
+     *
+     * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/get-customer
      */
     getMe(shopId: number, accessToken?: string): Promise<ShopUser>;
     /**
-     * Fetch a customer's order
-     * @see https://scayle.dev/api/oauth/latest/fetch-order-by-id
+     * Retrieve a customer's order.
+     *
+     * @see https://scayle.dev/en/api-guides/customer-account-api/resources/order/get-order
      */
     getOrder(shopId: number, orderId: number): Promise<Order>;
     /**
-     * Update the customer's contact details
+     * Update contact details of a customer.
      *
-     * @see https://scayle.dev/api/oauth/latest/put-customer-contact
+     * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-contact-details
      */
     updateContactInfo(shopId: number, { email, phone }: Partial<ContactData>): Promise<ShopUser>;
     /**
-     * Update the customer's personal details
+     * Update customer personal data.
+     *
+     * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-personal-data
      */
     updatePersonalInfo(shopId: number, payload: Partial<PersonalData>): Promise<ShopUser>;
     /**
-     * Update the customer's password
+     * Update customer password.
      *
-     * @see https://scayle.dev/api/oauth/latest/put-customer-password
+     * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-password
      */
     updatePassword(shopId: number, { password, newPassword }: PasswordUpdate): Promise<ShopUser>;
 }

package/dist/api/customer.mjs

@@ -59,7 +59,9 @@ export class CustomerAPIClient {
     throw new FetchError(response);
   }
   /**
-   * Get the addresses for the current customer
+   * Get the addresses for the current customer.
+   *
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/address/list-addresses
    */
   async getAddresses(shopId) {
     return await this.sendRequest(
@@ -73,8 +75,9 @@ export class CustomerAPIClient {
   }
   /**
    * Returns customer data and latest orders.
-   * When not logged in will return undefined.
-   * @see https://scayle.dev/api/oauth/latest/fetch-authorized-payload
+   * When not logged in, it will return `undefined`.
+   *
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/get-customer
    */
   async getMe(shopId, accessToken) {
     return await this.sendRequest(
@@ -88,8 +91,9 @@ export class CustomerAPIClient {
     );
   }
   /**
-   * Fetch a customer's order
-   * @see https://scayle.dev/api/oauth/latest/fetch-order-by-id
+   * Retrieve a customer's order.
+   *
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/order/get-order
    */
   async getOrder(shopId, orderId) {
     return this.sendRequest(
@@ -102,9 +106,9 @@ export class CustomerAPIClient {
     );
   }
   /**
-   * Update the customer's contact details
+   * Update contact details of a customer.
    *
-   * @see https://scayle.dev/api/oauth/latest/put-customer-contact
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-contact-details
    */
   async updateContactInfo(shopId, { email, phone }) {
     return await this.sendRequest(
@@ -122,7 +126,9 @@ export class CustomerAPIClient {
     );
   }
   /**
-   * Update the customer's personal details
+   * Update customer personal data.
+   *
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-personal-data
    */
   async updatePersonalInfo(shopId, payload) {
     return await this.sendRequest(
@@ -137,9 +143,9 @@ export class CustomerAPIClient {
     );
   }
   /**
-   * Update the customer's password
+   * Update customer password.
    *
-   * @see https://scayle.dev/api/oauth/latest/put-customer-password
+   * @see https://scayle.dev/en/api-guides/customer-account-api/resources/customer/update-password
    */
   async updatePassword(shopId, { password, newPassword }) {
     return await this.sendRequest(

package/dist/api/oauth.cjs

@@ -70,8 +70,11 @@ class OAuthClient {
     };
   }
   /**
-   * Register a user and retrieve a token set
+   * Register a new User and receive an access token.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/create-new-user
    */
   async register(payload) {
     this.logger?.debug("Registering user");
@@ -82,8 +85,11 @@ class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Execute a user login on the OAuth API and receive a token set
+   * Login a User and receive an access token.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users
    */
   async login(payload) {
     this.logger?.debug("Logging in");
@@ -94,8 +100,11 @@ class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Execute a guest user login on the OAuth API and receive a token set
+   * Login a User as a guest and receive an access token.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users-as-guest
    */
   async guestLogin(payload) {
     this.logger?.debug("Logging in as guest");
@@ -106,8 +115,11 @@ class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Send a password reset email
+   * Send a reset password email to a User.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/send-password-reset-email
    */
   async sendPasswordResetEmail(payload) {
     this.logger?.debug("Sending password reset email");
@@ -118,8 +130,12 @@ class OAuthClient {
     }).then(emptyOAuthResponseHandler);
   }
   /**
-   * Update password by hash
+   * Update password by using hash.
+   * All older tokens of the User are also invalidated.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/update-password-by-hash
    */
   async updatePasswordByHash(payload) {
     this.logger?.debug("Updating password by hash");
@@ -130,7 +146,8 @@ class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Update a user's password
+   * Update password via plain string.
+   *
    * @param payload
    * @param accessToken
    */
@@ -146,7 +163,8 @@ class OAuthClient {
     }).then(emptyOAuthResponseHandler);
   }
   /**
-   * Generate a new access token via a refresh token
+   * Generate a new access token via a refresh token.
+   *
    * @param payload
    */
   async refreshToken(payload) {
@@ -158,8 +176,11 @@ class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Validate an access token
+   * Validate a token.
+   *
    * @param accessToken
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/validate-present-token
    */
   async validateToken(accessToken) {
     this.logger?.debug("Validating access token");
@@ -171,9 +192,20 @@ class OAuthClient {
     }).then(emptyOAuthResponseHandler);
   }
   /**
-   * Revoke an access token
+   * Revoke an Access Token and all related Refresh Tokens.
+   *
+   * Uses a valid Bearer Access Token in the Authorization header and will
+   * revoke the token with the given ID (_which could be a different token_).
+   * If a external identity provider was used for the target token,
+   * the corresponding IDP-AccessToken and IDP-RefreshToken will be revoked as well.
+   * In case the identity provider does not support revoking tokens over api calls
+   * (_because a frontend redirect is required_) this step will be skipped and the IDP-Tokens
+   * will remain valid until they expire or are revoked from IDP side.
+   *
    * @param shopId
    * @param accessToken
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/delete-access-token-with-id
    */
   async revokeToken(shopId, accessToken) {
     this.logger?.debug("Revoking access token");
@@ -188,7 +220,8 @@ class OAuthClient {
     }).then(emptyOAuthResponseHandler);
   }
   /**
-   * Generate a new token based on authorization code
+   * Generate a new token based on authorization code.
+   *
    * @param code
    */
   async generateToken(code) {

package/dist/api/oauth.d.ts

@@ -10,7 +10,8 @@ export interface OAuthOptions {
 export declare function getOAuthClient(context: RpcContext): OAuthClient;
 /**
  * A client for interacting with the Checkout Authentication API
- * Docs for all the routes: https://gitlab.com/aboutyou/checkout/schemas/checkout-auth-api/-/blob/main/build/openapi.yaml
+ *
+ * @see https://scayle.dev/en/api-guides/checkout-authentication-api
  */
 export declare class OAuthClient {
     headers: HeadersInit;
@@ -19,54 +20,87 @@ export declare class OAuthClient {
     clientId: string;
     constructor(options: OAuthOptions, logger?: Log);
     /**
-     * Register a user and retrieve a token set
+     * Register a new User and receive an access token.
+     *
      * @param payload
+     *
+     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/create-new-user
      */
     register(payload: RegisterRequest): Promise<Oauth>;
     /**
-     * Execute a user login on the OAuth API and receive a token set
+     * Login a User and receive an access token.
+     *
      * @param payload
+     *
+     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users
      */
     login(payload: LoginRequest): Promise<Oauth>;
     /**
-     * Execute a guest user login on the OAuth API and receive a token set
+     * Login a User as a guest and receive an access token.
+     *
      * @param payload
+     *
+     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users-as-guest
      */
     guestLogin(payload: GuestRequest): Promise<Oauth>;
     /**
-     * Send a password reset email
+     * Send a reset password email to a User.
+     *
      * @param payload
+     *
+     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/send-password-reset-email
      */
     sendPasswordResetEmail(payload: SendResetPasswordEmailRequest): Promise<void>;
     /**
-     * Update password by hash
+     * Update password by using hash.
+     * All older tokens of the User are also invalidated.
+     *
      * @param payload
+     *
+     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/update-password-by-hash
      */
     updatePasswordByHash(payload: UpdatePasswordByHashRequest): Promise<Oauth>;
     /**
-     * Update a user's password
+     * Update password via plain string.
+     *
      * @param payload
      * @param accessToken
      */
     updatePassword(payload: UpdatePasswordRequest, accessToken: string): Promise<void>;
     /**
-     * Generate a new access token via a refresh token
+     * Generate a new access token via a refresh token.
+     *
      * @param payload
      */
     refreshToken(payload: RefreshTokenRequest): Promise<Oauth>;
     /**
-     * Validate an access token
+     * Validate a token.
+     *
      * @param accessToken
+     *
+     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/validate-present-token
      */
     validateToken(accessToken: string): Promise<void>;
     /**
-     * Revoke an access token
+     * Revoke an Access Token and all related Refresh Tokens.
+     *
+     * Uses a valid Bearer Access Token in the Authorization header and will
+     * revoke the token with the given ID (_which could be a different token_).
+     * If a external identity provider was used for the target token,
+     * the corresponding IDP-AccessToken and IDP-RefreshToken will be revoked as well.
+     * In case the identity provider does not support revoking tokens over api calls
+     * (_because a frontend redirect is required_) this step will be skipped and the IDP-Tokens
+     * will remain valid until they expire or are revoked from IDP side.
+     *
      * @param shopId
      * @param accessToken
+     *
+     * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/delete-access-token-with-id
      */
     revokeToken(shopId: number, accessToken: string): Promise<void>;
     /**
-     * Generate a new token based on authorization code
+     * Generate a new token based on authorization code.
+     *
      * @param code
      */
     generateToken(code: string): Promise<Oauth>;

package/dist/api/oauth.mjs

@@ -56,8 +56,11 @@ export class OAuthClient {
     };
   }
   /**
-   * Register a user and retrieve a token set
+   * Register a new User and receive an access token.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/create-new-user
    */
   async register(payload) {
     this.logger?.debug("Registering user");
@@ -68,8 +71,11 @@ export class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Execute a user login on the OAuth API and receive a token set
+   * Login a User and receive an access token.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users
    */
   async login(payload) {
     this.logger?.debug("Logging in");
@@ -80,8 +86,11 @@ export class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Execute a guest user login on the OAuth API and receive a token set
+   * Login a User as a guest and receive an access token.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/log-in-users-as-guest
    */
   async guestLogin(payload) {
     this.logger?.debug("Logging in as guest");
@@ -92,8 +101,11 @@ export class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Send a password reset email
+   * Send a reset password email to a User.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/send-password-reset-email
    */
   async sendPasswordResetEmail(payload) {
     this.logger?.debug("Sending password reset email");
@@ -104,8 +116,12 @@ export class OAuthClient {
     }).then(emptyOAuthResponseHandler);
   }
   /**
-   * Update password by hash
+   * Update password by using hash.
+   * All older tokens of the User are also invalidated.
+   *
    * @param payload
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/oauth-client/update-password-by-hash
    */
   async updatePasswordByHash(payload) {
     this.logger?.debug("Updating password by hash");
@@ -116,7 +132,8 @@ export class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Update a user's password
+   * Update password via plain string.
+   *
    * @param payload
    * @param accessToken
    */
@@ -132,7 +149,8 @@ export class OAuthClient {
     }).then(emptyOAuthResponseHandler);
   }
   /**
-   * Generate a new access token via a refresh token
+   * Generate a new access token via a refresh token.
+   *
    * @param payload
    */
   async refreshToken(payload) {
@@ -144,8 +162,11 @@ export class OAuthClient {
     }).then(oauthResponseHandler);
   }
   /**
-   * Validate an access token
+   * Validate a token.
+   *
    * @param accessToken
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/validate-present-token
    */
   async validateToken(accessToken) {
     this.logger?.debug("Validating access token");
@@ -157,9 +178,20 @@ export class OAuthClient {
     }).then(emptyOAuthResponseHandler);
   }
   /**
-   * Revoke an access token
+   * Revoke an Access Token and all related Refresh Tokens.
+   *
+   * Uses a valid Bearer Access Token in the Authorization header and will
+   * revoke the token with the given ID (_which could be a different token_).
+   * If a external identity provider was used for the target token,
+   * the corresponding IDP-AccessToken and IDP-RefreshToken will be revoked as well.
+   * In case the identity provider does not support revoking tokens over api calls
+   * (_because a frontend redirect is required_) this step will be skipped and the IDP-Tokens
+   * will remain valid until they expire or are revoked from IDP side.
+   *
    * @param shopId
    * @param accessToken
+   *
+   * @see https://scayle.dev/en/api-guides/checkout-authentication-api/resources/bearer-auth/delete-access-token-with-id
    */
   async revokeToken(shopId, accessToken) {
     this.logger?.debug("Revoking access token");
@@ -174,7 +206,8 @@ export class OAuthClient {
     }).then(emptyOAuthResponseHandler);
   }
   /**
-   * Generate a new token based on authorization code
+   * Generate a new token based on authorization code.
+   *
    * @param code
    */
   async generateToken(code) {

package/dist/rpc/methods/checkout/checkout.cjs

@@ -37,7 +37,7 @@ const getCheckoutToken = exports.getCheckoutToken = async function getCheckoutTo
     carrier,
     basketId: context.basketKey,
     campaignKey: context.campaignKey
-  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.3.2"}`).setProtectedHeader({
+  }).setIssuedAt(now).setNotBefore(now).setExpirationTime("1h").setIssuer(`${"@scayle/storefront-core"}@${"8.4.0"}`).setProtectedHeader({
     alg: "HS256",
     typ: "JWT"
   }).sign(secret);

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

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

package/dist/types/user.d.ts

@@ -1,6 +1,6 @@
 import type { UseBasketParams } from './sapi/basket';
 import type { UseWishlistParams } from './sapi/wishlist';
-export type Gender = 'm' | 'f' | 'd';
+export type Gender = 'm' | 'f' | 'd' | 'n';
 export interface UpdatePasswordParams {
     oldPassword: string;
     newPassword: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-core",
-  "version": "8.3.2",
+  "version": "8.4.0",
   "description": "Collection of essential utilities to work with the Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",